Module: KeycloakApiRails

Defined in:
lib/keycloak-api-rails.rb,
lib/keycloak-api-rails/helper.rb,
lib/keycloak-api-rails/railtie.rb,
lib/keycloak-api-rails/service.rb,
lib/keycloak-api-rails/testing.rb,
lib/keycloak-api-rails/version.rb,
lib/keycloak-api-rails/middleware.rb,
lib/keycloak-api-rails/http_client.rb,
lib/keycloak-api-rails/configuration.rb,
lib/keycloak-api-rails/authentication.rb,
lib/keycloak-api-rails/public_key_resolver.rb,
lib/keycloak-api-rails/public_key_cached_resolver.rb

Defined Under Namespace

Modules: Authentication, Testing Classes: Configuration, HTTPClient, Helper, Middleware, PublicKeyCachedResolver, PublicKeyResolver, Railtie, Service

Constant Summary collapse

VERSION = 
"1.1.1"

Class Method Summary collapse

Class Method Details

.config ⇒ Object 



24
25
26
 
# File 'lib/keycloak-api-rails.rb', line 24

def self.config
  @configuration
end

.configure {|@configuration ||= KeycloakApiRails::Configuration.new| ... } ⇒ Object

Yields:



20
21
22
 
# File 'lib/keycloak-api-rails.rb', line 20

def self.configure
  yield @configuration ||= KeycloakApiRails::Configuration.new
end

.http_client ⇒ Object 



28
29
30
 
# File 'lib/keycloak-api-rails.rb', line 28

def self.http_client
  @http_client ||= KeycloakApiRails::HTTPClient.new(config, logger)
end

.load_configuration ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/keycloak-api-rails.rb', line 52

def self.load_configuration
  configure do |config|
    config.server_url                             = nil
    config.realm_id                               = nil
    config.logger                                 = ::Logger.new(STDOUT)
    config.skip_paths                             = {}
    config.opt_in                                 = false
    config.token_expiration_tolerance_in_seconds  = 10
    config.public_key_cache_ttl                   = 86400
    config.custom_attributes                      = []
  end
end

.logger ⇒ Object 



48
49
50
 
# File 'lib/keycloak-api-rails.rb', line 48

def self.logger
  config.logger
end

.public_key_resolver ⇒ Object 



32
33
34
 
# File 'lib/keycloak-api-rails.rb', line 32

def self.public_key_resolver
  @public_key_resolver ||= PublicKeyCachedResolver.from_configuration(http_client, config)
end

.public_key_resolver=(resolver) ⇒ Object

Mainly used by "keycloak-api-rails/testing" to validate tokens without a Keycloak server. Assigning nil restores the regular resolver. The memoized service is discarded, since it holds a reference to the resolver that is being replaced.



39
40
41
42
 
# File 'lib/keycloak-api-rails.rb', line 39

def self.public_key_resolver=(resolver)
  @public_key_resolver = resolver
  @service             = nil
end

.service ⇒ Object 



44
45
46
 
# File 'lib/keycloak-api-rails.rb', line 44

def self.service
  @service ||= KeycloakApiRails::Service.new(public_key_resolver)
end