Class: OAuth2::AccessToken - - - -
--
-
- Inherits: -
-
- Object
-
-
-
-
- Object - -
- OAuth2::AccessToken - -
-
-
-
- Includes: -
- FilteredAttributes -
-
-
- Defined in: -
- lib/oauth2/access_token.rb -
Overview
rubocop:disable Metrics/ClassLength
- - -- Constant Summary - collapse -
- --
-
-
- TOKEN_KEYS_STR = - - -
%w[access_token id_token token accessToken idToken].freeze
-
- - TOKEN_KEYS_SYM = - - -
%i[access_token id_token token accessToken idToken].freeze
-
- - TOKEN_KEY_LOOKUP = - - -
TOKEN_KEYS_STR + TOKEN_KEYS_SYM
-
-
Instance Attribute Summary collapse
--
-
-
-
-
-
- #client ⇒ Object
-
-
-
-
-
-
-
-
- readonly
-
-
-
-
-
-
-
-
-
- - -
Returns the value of attribute client.
-
-
-
- -
-
-
- #expires_at ⇒ Object
-
-
-
-
-
-
-
-
- readonly
-
-
-
-
-
-
-
-
-
- - -
Returns the value of attribute expires_at.
-
-
-
- -
-
-
- #expires_in ⇒ Object
-
-
-
-
-
-
-
-
- readonly
-
-
-
-
-
-
-
-
-
- - -
Returns the value of attribute expires_in.
-
-
-
- -
-
-
- #expires_latency ⇒ Object
-
-
-
-
-
-
-
-
- readonly
-
-
-
-
-
-
-
-
-
- - -
Returns the value of attribute expires_latency.
-
-
-
- -
-
-
- #options ⇒ Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
Returns the value of attribute options.
-
-
-
- -
-
-
- #params ⇒ Object
-
-
-
-
-
-
-
-
- readonly
-
-
-
-
-
-
-
-
-
- - -
Returns the value of attribute params.
-
-
-
- -
-
-
- #refresh_token ⇒ Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
Returns the value of attribute refresh_token.
-
-
-
- -
-
-
- #response ⇒ Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
Returns the value of attribute response.
-
-
-
- -
-
-
- #token ⇒ Object
-
-
-
-
-
-
-
-
- readonly
-
-
-
-
-
-
-
-
-
- - -
Returns the value of attribute token.
-
-
-
-
- Class Method Summary - collapse -
- --
-
-
-
-
-
- .from_hash(client, hash) ⇒ OAuth2::AccessToken
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
Initializes an AccessToken from a Hash.
-
-
-
- -
-
-
- .from_kvform(client, kvform) ⇒ AccessToken
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
Initializes an AccessToken from a key/value application/x-www-form-urlencoded string.
-
-
-
-
- Instance Method Summary - collapse -
- --
-
-
-
-
-
- #[](key) ⇒ Object
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
Indexer to additional params present in token response.
-
-
-
- -
-
-
- #delete(path, opts = {}, &block) ⇒ Object
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
Make a DELETE request with the Access Token.
-
-
-
- -
-
-
- #expired? ⇒ Boolean
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
Check if token is expired.
-
-
-
- -
-
-
- #expires? ⇒ Boolean
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
Whether the token expires.
-
-
-
- -
-
-
- #get(path, opts = {}, &block) ⇒ Object
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
Make a GET request with the Access Token.
-
-
-
- -
-
-
- #headers ⇒ Object
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
Get the headers hash (includes Authorization token).
-
-
-
- -
-
-
- #initialize(client, token, opts = {}) ⇒ AccessToken
-
-
-
-
-
-
- constructor
-
-
-
-
-
-
-
-
- - -
Initialize an AccessToken.
-
-
-
- -
-
-
- #patch(path, opts = {}, &block) ⇒ Object
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
Make a PATCH request with the Access Token.
-
-
-
- -
-
-
- #post(path, opts = {}, &block) ⇒ Object
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
Make a POST request with the Access Token.
-
-
-
- -
-
-
- #put(path, opts = {}, &block) ⇒ Object
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
Make a PUT request with the Access Token.
-
-
-
- -
-
-
- #refresh(params = {}, access_token_opts = {}) {|opts| ... } ⇒ OAuth2::AccessToken
-
-
-
- (also: #refresh!)
-
-
-
-
-
-
-
-
-
-
-
- - -
Refreshes the current Access Token.
-
-
-
- -
-
-
- #request(verb, path, opts = {}) {|req| ... } ⇒ OAuth2::Response
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
Make a request with the Access Token.
-
-
-
- -
-
-
- #revoke(params = {}) {|req| ... } ⇒ OAuth2::Response
-
-
-
- (also: #revoke!)
-
-
-
-
-
-
-
-
-
-
-
- - -
Revokes the token at the authorization server.
-
-
-
- -
-
-
- #to_hash ⇒ Hash
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
Convert AccessToken to a hash which can be used to rebuild itself with AccessToken.from_hash.
-
-
-
-
Methods included from FilteredAttributes
- -Constructor Details
- -- - #initialize(client, token, opts = {}) ⇒ AccessToken - - - - - -
For “soon-to-expire”/”clock-skew” functionality see the :expires_latency option.
If no token is provided, the AccessToken will be considered invalid.
-This is to prevent the possibility of a token being accidentally
-created with no token value.
-If you want to create an AccessToken with no token value,
-you can pass in an empty string or nil for the token value.
-If you want to create an AccessToken with no token value and
-no refresh token, you can pass in an empty string or nil for the
-token value and nil for the refresh token, and raise_errors: false.
Initialize an AccessToken
- - -
- - - -148 -149 -150 -151 -152 -153 -154 -155 -156 -157 -158 -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181- |
-
- # File 'lib/oauth2/access_token.rb', line 148 - -def initialize(client, token, opts = {}) - @client = client - @token = token.to_s - opts = opts.dup - %i[refresh_token expires_in expires_at expires_latency].each do |arg| - instance_variable_set("@#{arg}", opts.delete(arg) || opts.delete(arg.to_s)) - end - no_tokens = (@token.nil? || @token.empty?) && (@refresh_token.nil? || @refresh_token.empty?) - if no_tokens - if @client.[:raise_errors] - raise Error.new({ - error: "OAuth2::AccessToken has no token", - error_description: "Options are: #{opts.inspect}", - }) - elsif !OAuth2.config.silence_no_tokens_warning - warn("OAuth2::AccessToken has no token") - end - end - # @option opts [Fixnum, String] :expires is deprecated - @expires_in ||= opts.delete("expires") - @expires_in &&= @expires_in.to_i - @expires_at &&= convert_expires_at(@expires_at) - @expires_latency &&= @expires_latency.to_i - @expires_at ||= Time.now.to_i + @expires_in if @expires_in && !@expires_in.zero? - @expires_at -= @expires_latency if @expires_latency - @options = { - mode: opts.delete(:mode) || :header, - header_format: opts.delete(:header_format) || "Bearer %s", - param_name: opts.delete(:param_name) || "access_token", - } - @options[:token_name] = opts.delete(:token_name) if opts.key?(:token_name) - - @params = opts -end- |
-
Instance Attribute Details
- - - -- - #client ⇒ Object (readonly) - - - - - -
Returns the value of attribute client.
- - -
- - - -26 -27 -28- |
-
- # File 'lib/oauth2/access_token.rb', line 26 - -def client - @client -end- |
-
- - #expires_at ⇒ Object (readonly) - - - - - -
Returns the value of attribute expires_at.
- - -
- - - -26 -27 -28- |
-
- # File 'lib/oauth2/access_token.rb', line 26 - -def expires_at - @expires_at -end- |
-
- - #expires_in ⇒ Object (readonly) - - - - - -
Returns the value of attribute expires_in.
- - -
- - - -26 -27 -28- |
-
- # File 'lib/oauth2/access_token.rb', line 26 - -def expires_in - @expires_in -end- |
-
- - #expires_latency ⇒ Object (readonly) - - - - - -
Returns the value of attribute expires_latency.
- - -
- - - -26 -27 -28- |
-
- # File 'lib/oauth2/access_token.rb', line 26 - -def expires_latency - @expires_latency -end- |
-
- - #options ⇒ Object - - - - - -
Returns the value of attribute options.
- - -
- - - -27 -28 -29- |
-
- # File 'lib/oauth2/access_token.rb', line 27 - -def - @options -end- |
-
- - #params ⇒ Object (readonly) - - - - - -
Returns the value of attribute params.
- - -
- - - -26 -27 -28- |
-
- # File 'lib/oauth2/access_token.rb', line 26 - -def params - @params -end- |
-
- - #refresh_token ⇒ Object - - - - - -
Returns the value of attribute refresh_token.
- - -
- - - -27 -28 -29- |
-
- # File 'lib/oauth2/access_token.rb', line 27 - -def refresh_token - @refresh_token -end- |
-
- - #response ⇒ Object - - - - - -
Returns the value of attribute response.
- - -
- - - -27 -28 -29- |
-
- # File 'lib/oauth2/access_token.rb', line 27 - -def response - @response -end- |
-
- - #token ⇒ Object (readonly) - - - - - -
Returns the value of attribute token.
- - -
- - - -26 -27 -28- |
-
- # File 'lib/oauth2/access_token.rb', line 26 - -def token - @token -end- |
-
Class Method Details
- - -- - .from_hash(client, hash) ⇒ OAuth2::AccessToken - - - - - -
The method will use the first found token key in the following order:
-‘access_token’, ‘id_token’, ‘token’ (or their symbolic versions)
If multiple token keys are present, a warning will be issued unless
-OAuth2.config.silence_extra_tokens_warning is true
If no token keys are present, a warning will be issued unless
-OAuth2.config.silence_no_tokens_warning is true
For “soon-to-expire”/”clock-skew” functionality see the :expires_latency option.
If snaky key conversion is being used, token_name needs to match the converted key.
-Initializes an AccessToken from a Hash
- - -
- - - -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83- |
-
- # File 'lib/oauth2/access_token.rb', line 57 - -def from_hash(client, hash) - fresh = hash.dup - # If token_name is present, then use that key name - key = - if fresh.key?(:token_name) - t_key = fresh[:token_name] - no_tokens_warning(fresh, t_key) - t_key - else - # Otherwise, if one of the supported default keys is present, use whichever has precedence - supported_keys = TOKEN_KEY_LOOKUP & fresh.keys - t_key = supported_keys[0] - extra_tokens_warning(supported_keys, t_key) - t_key - end - # :nocov: - # TODO: Get rid of this branching logic when dropping Hashie < v3.2 - token = if !defined?(Hashie::VERSION) # i.e. <= "1.1.0"; the first Hashie to ship with a VERSION constant - warn("snaky_hash and oauth2 will drop support for Hashie v0 in the next major version. Please upgrade to a modern Hashie.") - # There is a bug in Hashie v0, which is accounts for. - fresh.delete(key) || fresh[key] || "" - else - fresh.delete(key) || "" - end - # :nocov: - new(client, token, fresh) -end- |
-
- - .from_kvform(client, kvform) ⇒ AccessToken - - - - - -
Initializes an AccessToken from a key/value application/x-www-form-urlencoded string
- - -
- - - -90 -91 -92- |
-
- # File 'lib/oauth2/access_token.rb', line 90 - -def from_kvform(client, kvform) - from_hash(client, Rack::Utils.parse_query(kvform)) -end- |
-
Instance Method Details
- - -- - #[](key) ⇒ Object - - - - - -
Indexer to additional params present in token response
- - -
- - - -186 -187 -188- |
-
- # File 'lib/oauth2/access_token.rb', line 186 - -def [](key) - @params[key] -end- |
-
- - #delete(path, opts = {}, &block) ⇒ Object - - - - - -
Make a DELETE request with the Access Token
- - -
- - - -368 -369 -370- |
-
- # File 'lib/oauth2/access_token.rb', line 368 - -def delete(path, opts = {}, &block) - request(:delete, path, opts, &block) -end- |
-
- - #expired? ⇒ Boolean - - - - - -
Check if token is expired
- - -
- - - -200 -201 -202- |
-
- # File 'lib/oauth2/access_token.rb', line 200 - -def expired? - expires? && (expires_at <= Time.now.to_i) -end- |
-
- - #expires? ⇒ Boolean - - - - - -
Whether the token expires
- - -
- - - -193 -194 -195- |
-
- # File 'lib/oauth2/access_token.rb', line 193 - -def expires? - !!@expires_at -end- |
-
- - #get(path, opts = {}, &block) ⇒ Object - - - - - -
Make a GET request with the Access Token
- - -
- - - -340 -341 -342- |
-
- # File 'lib/oauth2/access_token.rb', line 340 - -def get(path, opts = {}, &block) - request(:get, path, opts, &block) -end- |
-
- - #headers ⇒ Object - - - - - -
Get the headers hash (includes Authorization token)
- - -
- - - -373 -374 -375- |
-
- # File 'lib/oauth2/access_token.rb', line 373 - -def headers - {"Authorization" => [:header_format] % token} -end- |
-
- - #patch(path, opts = {}, &block) ⇒ Object - - - - - -
Make a PATCH request with the Access Token
- - -
- - - -361 -362 -363- |
-
- # File 'lib/oauth2/access_token.rb', line 361 - -def patch(path, opts = {}, &block) - request(:patch, path, opts, &block) -end- |
-
- - #post(path, opts = {}, &block) ⇒ Object - - - - - -
Make a POST request with the Access Token
- - -
- - - -347 -348 -349- |
-
- # File 'lib/oauth2/access_token.rb', line 347 - -def post(path, opts = {}, &block) - request(:post, path, opts, &block) -end- |
-
- - #put(path, opts = {}, &block) ⇒ Object - - - - - -
Make a PUT request with the Access Token
- - -
- - - -354 -355 -356- |
-
- # File 'lib/oauth2/access_token.rb', line 354 - -def put(path, opts = {}, &block) - request(:put, path, opts, &block) -end- |
-
- - #refresh(params = {}, access_token_opts = {}) {|opts| ... } ⇒ OAuth2::AccessToken - - - - Also known as: - refresh! - - - - -
current token’s options are carried over to the new AccessToken
-Refreshes the current Access Token
- - -
- - - -215 -216 -217 -218 -219 -220 -221 -222 -223 -224 -225 -226 -227 -228- |
-
- # File 'lib/oauth2/access_token.rb', line 215 - -def refresh(params = {}, access_token_opts = {}, &block) - raise OAuth2::Error.new({error: "A refresh_token is not available"}) unless refresh_token - - params[:grant_type] = "refresh_token" - params[:refresh_token] = refresh_token - new_token = @client.get_token(params, access_token_opts, &block) - new_token. = - if new_token.refresh_token - # Keep it if there is one - else - new_token.refresh_token = refresh_token - end - new_token -end- |
-
- - #request(verb, path, opts = {}) {|req| ... } ⇒ OAuth2::Response - - - - - -
Make a request with the Access Token
- - -
- - - -332 -333 -334 -335- |
-
- # File 'lib/oauth2/access_token.rb', line 332 - -def request(verb, path, opts = {}, &block) - configure_authentication!(opts, verb) - @client.request(verb, path, opts, &block) -end- |
-
- - #revoke(params = {}) {|req| ... } ⇒ OAuth2::Response - - - - Also known as: - revoke! - - - - -
If the token passed to the request
-is an access token, the server MAY revoke the respective refresh
-token as well.
If the token passed to the request
-is a refresh token and the authorization server supports the
-revocation of access tokens, then the authorization server SHOULD
-also invalidate all access tokens based on the same authorization
-grant
If the server responds with HTTP status code 503, your code must
-assume the token still exists and may retry after a reasonable delay.
-The server may include a “Retry-After” header in the response to
-indicate how long the service is expected to be unavailable to the
-requesting client.
Revokes the token at the authorization server
- - -
- - - -264 -265 -266 -267 -268 -269 -270 -271 -272 -273 -274 -275 -276 -277 -278 -279 -280 -281 -282 -283 -284 -285 -286 -287 -288- |
-
- # File 'lib/oauth2/access_token.rb', line 264 - -def revoke(params = {}, &block) - token_type_hint_orig = params.delete(:token_type_hint) - token_type_hint = nil - revoke_token = case token_type_hint_orig - when "access_token", :access_token - token_type_hint = "access_token" - token - when "refresh_token", :refresh_token - token_type_hint = "refresh_token" - refresh_token - when nil - if token - token_type_hint = "access_token" - token - elsif refresh_token - token_type_hint = "refresh_token" - refresh_token - end - else - raise OAuth2::Error.new({error: "token_type_hint must be one of [nil, :refresh_token, :access_token], so if you need something else consider using a subclass or entirely custom AccessToken class."}) - end - raise OAuth2::Error.new({error: "#{token_type_hint || "unknown token type"} is not available for revoking"}) unless revoke_token && !revoke_token.empty? - - @client.revoke_token(revoke_token, token_type_hint, params, &block) -end- |
-
- - #to_hash ⇒ Hash - - - - - -
Don’t return expires_latency because it has already been deducted from expires_at
-Convert AccessToken to a hash which can be used to rebuild itself with AccessToken.from_hash
- - -
- - - -298 -299 -300 -301 -302 -303 -304 -305 -306 -307 -308 -309 -310 -311 -312 -313 -314 -315- |
-
- # File 'lib/oauth2/access_token.rb', line 298 - -def to_hash - hsh = { - access_token: token, - refresh_token: refresh_token, - expires_at: expires_at, - mode: [:mode], - header_format: [:header_format], - param_name: [:param_name], - } - hsh[:token_name] = [:token_name] if .key?(:token_name) - # TODO: Switch when dropping Ruby < 2.5 support - # params.transform_keys(&:to_sym) # Ruby 2.5 only - # Old Ruby transform_keys alternative: - sheesh = @params.each_with_object({}) { |(k, v), memo| - memo[k.to_sym] = v - } - sheesh.merge(hsh) -end- |
-