Class: Setsuzoku::Service::WebService::AuthStrategies::BasicAuthStrategy

Inherits:
Setsuzoku::Service::WebService::AuthStrategy show all
Extended by:
T::Helpers, T::Sig
Defined in:
lib/setsuzoku/service/web_service/auth_strategies/basic_auth_strategy.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 the basic auth strategy.

Instance Attribute Summary

Attributes included from AuthStrategy

#credential, #service

Attributes included from HasConfigContext

#config_context

Class Method Summary collapse

Instance Method Summary collapse

Methods included from AuthStrategy

#initialize, #new_credential!, #set_credential!

Methods included from HasConfigContext

#get_from_context

Class Method Details

.credential_class ⇒ Object 



20
21
22
 
# File 'lib/setsuzoku/service/web_service/auth_strategies/basic_auth_strategy.rb', line 20

def self.credential_class
  Setsuzoku::Service::WebService::Credentials::BasicAuthCredential
end

.required_instance_methods ⇒ Object 



16
17
18
 
# File 'lib/setsuzoku/service/web_service/auth_strategies/basic_auth_strategy.rb', line 16

def self.required_instance_methods
  []
end

Instance Method Details

#auth_credential_valid? ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/setsuzoku/service/web_service/auth_strategies/basic_auth_strategy.rb', line 44

def auth_credential_valid?
  true
end

#auth_headers ⇒ Object 



28
29
30
31
32
33
34
35
36
37
 
# File 'lib/setsuzoku/service/web_service/auth_strategies/basic_auth_strategy.rb', line 28

def auth_headers
  {
    authorization: {
      basic_auth: {
        username: self.credential.username,
        password: self.credential.password
      }
    }
  }
end