Module: Setsuzoku::Service::WebService::AuthStrategies::StrategyCanUseTokens

Extended by:

T::Helpers, T::Sig

Included in:

CustomAuthStrategy, OAuthStrategy

Defined in:

lib/setsuzoku/service/web_service/auth_strategies/strategy_can_use_tokens.rb

Overview

The API OAuth Authentication Interface definition. Any Plugin that implements this must implement all methods required for OAuth.

Defines all necessary methods for handling authentication for any authentication strategy.

Instance Method Summary

• #auth_credential_valid? ⇒ Boolean

  If the auth credentials are valid for this instance and auth_strategy.

• #new_token! ⇒ void

  Construct the custom token_request_body and request a token.

Instance Method Details

#auth_credential_valid? ⇒ Boolean

If the auth credentials are valid for this instance and auth_strategy.

If the token is invalid we should refresh it. And verify that the credentials are now valid. Otherwise the credentials are already valid.

Returns:

• (Boolean) —

  true if the auth token is valid for the auth_strategy.

# File 'lib/setsuzoku/service/web_service/auth_strategies/strategy_can_use_tokens.rb', line 44

def auth_credential_valid?
  validate_token_credential!
end

#new_token! ⇒ void

This method returns an undefined value.

Construct the custom token_request_body and request a token.

# File 'lib/setsuzoku/service/web_service/auth_strategies/strategy_can_use_tokens.rb', line 23

def new_token!; end