oauth

Documentation

Index

• Constants
• func IsProviderEnabled(name string) bool
• type HTTPService
  • func (p *HTTPService) GetAuthURL(authEndpoint string, provider string, redirect string) string
  • func (p *HTTPService) GetProfile(authEndpoint string, provider string, code string) (*UserProfile, error)
• type MockOAuthService
  • func (p *MockOAuthService) GetAuthURL(authEndpoint string, provider string, redirect string) string
  • func (p *MockOAuthService) GetProfile(authEndpoint string, provider string, code string) (*UserProfile, error)
• type Service
• type UserProfile

Constants

const (
	//FacebookProvider is const for 'facebook'
	FacebookProvider = "facebook"
	//GoogleProvider is const for 'google'
	GoogleProvider = "google"
)

Functions

func IsProviderEnabled

func IsProviderEnabled(name string) bool

IsProviderEnabled returns true if provider is enabled

Types

type HTTPService

type HTTPService struct{}

HTTPService implements real OAuth operations using Golang's oauth2 package

func (*HTTPService) GetAuthURL

func (p *HTTPService) GetAuthURL(authEndpoint string, provider string, redirect string) string

GetAuthURL returns authentication url for given provider

func (*HTTPService) GetProfile

func (p *HTTPService) GetProfile(authEndpoint string, provider string, code string) (*UserProfile, error)

GetProfile returns user profile based on provider and code

type MockOAuthService

type MockOAuthService struct{}

MockOAuthService implements a mocked OAuthService

func (*MockOAuthService) GetAuthURL

func (p *MockOAuthService) GetAuthURL(authEndpoint string, provider string, redirect string) string

GetAuthURL returns authentication url for given provider

func (*MockOAuthService) GetProfile

func (p *MockOAuthService) GetProfile(authEndpoint string, provider string, code string) (*UserProfile, error)

GetProfile returns user profile based on provider and code

type Service

type Service interface {
	GetAuthURL(authEndpoint string, provider string, redirect string) string
	GetProfile(authEndpoint string, provider string, code string) (*UserProfile, error)
}

Service provides OAuth operations

type UserProfile

type UserProfile struct {
	ID    string
	Name  string
	Email string
}

UserProfile represents an OAuth user profile