keycloak-api-rails 0.8 → 0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1dccb3ffb713201d9f49eff3c27ad657b739b149
-  data.tar.gz: 2df036761b9f6f6c398d0c7efb562117ace84e26
+  metadata.gz: 1d291e8d66fe760d36ba51a38fdc340cf73ba70a
+  data.tar.gz: aa7a777c5708e2e427ba135489e1547f065e315d
 SHA512:
-  metadata.gz: 5c0fa11f8adf1de64b83232581a3f2e8f11985c73e4b4db47f36b3af9039fd0baf569deb176d40ee9b7c1e3f7a42ad7676ea8cb4e98f61918751940ed5e05e6b
-  data.tar.gz: 916976afd9cd7f77f5c587889a6ed01515a708216bf2bbc1ae4d01673b468f4cfd0d692d12d42a8d476718f4d621422afb6b1ad4cf88998d6d6771b3986b148c
+  metadata.gz: 02ccaced32e6599c226300f48246c97a8ffdfdd3ef2adb85d6cde4862c4f3375e2695636f3fd0a51ca6f437fc4f66f6494a8c2d4bd20a5c1b6fb962dc7591cfc
+  data.tar.gz: 5577788c4255d19f5f62e46f2989ee0b33167cf9af8461dd19b9d29d3c6588eb3766bc8473533a8a1c71792910c0c45fe82908c81c7d822148303fea7a4c47e3

data/README.md

@@ -5,7 +5,7 @@ This gem aims at validates Keycloak JWT token in Ruby On Rails APIs.
 ## Install
 
 ```ruby
-gem "keycloak-api-rails", "0.8"
+gem "keycloak-api-rails", "0.10"
 ```
 
 ## Token validation
@@ -41,6 +41,7 @@ All options have a default value. However, all of them can be changed in your in
 | `skip_paths` | `{}`| Hash of methods and paths regexp | Optional | Paths whose the token must not be validatefd | `{ get: [/^\/health\/.+/] }`| 
 | `token_expiration_tolerance_in_seconds` | `10`| Logger | Optional | Number of seconds a token can expire before being rejected by the API. | `15` | 
 | `public_key_cache_ttl` | `86400`| Integer | Optional | Amount of time, in seconds, specifying maximum interval between two requests to {project_name} to retrieve new public keys. It is 86400 seconds (1 day) by default. At least once per this configured interval (1 day by default) will be new public key always downloaded. | `Rails.logger` | 
+| `custom_attributes` | `[]`| Array Of String | Optional | List of token attributes to read from each token and to add to their http request env | `["originalFirstName", "originalLastName"]` | 
 
 ## Configure it 
 

data/lib/keycloak-api-rails.rb

@@ -42,6 +42,7 @@ module Keycloak
       config.skip_paths                             = {}
       config.token_expiration_tolerance_in_seconds  = 10
       config.public_key_cache_ttl                   = 86400
+      config.custom_attributes                      = []
     end
   end
 

data/lib/keycloak-api-rails/configuration.rb

@@ -6,6 +6,7 @@ module Keycloak
     config_accessor :skip_paths
     config_accessor :token_expiration_tolerance_in_seconds
     config_accessor :public_key_cache_ttl
+    config_accessor :custom_attributes
     config_accessor :logger
   end
 end

data/lib/keycloak-api-rails/helper.rb

@@ -4,6 +4,7 @@ module Keycloak
     CURRENT_USER_ID_KEY     = "keycloak:keycloak_id"
     CURRENT_USER_EMAIL_KEY  = "keycloak:email"
     CURRENT_USER_LOCALE_KEY = "keycloak:locale"
+    CURRENT_USER_ATTRIBUTES = "keycloak:attributes"
     ROLES_KEY               = "keycloak:roles"
     QUERY_STRING_TOKEN_KEY  = "authorizationToken"
 
@@ -39,6 +40,18 @@ module Keycloak
       env[ROLES_KEY] = token.dig("realm_access", "roles")
     end
 
+    def self.assign_current_user_custom_attributes(env, token, attribute_names)
+      env[CURRENT_USER_ATTRIBUTES] = token.select { |key,value| attribute_names.include?(key) }
+    end
+
+    def self.current_user_custom_attributes(env)
+      env[CURRENT_USER_ATTRIBUTES]
+    end
+
+    def self.current_user_roles(env)
+      env[ROLES_KEY]
+    end
+
     def self.read_token_from_query_string(uri)
       parsed_uri         = URI.parse(uri)
       query              = URI.decode_www_form(parsed_uri.query || "")

data/lib/keycloak-api-rails/middleware.rb

@@ -32,6 +32,7 @@ module Keycloak
       Helper.assign_current_user_id(env, decoded_token)
       Helper.assign_current_user_email(env, decoded_token)
       Helper.assign_current_user_locale(env, decoded_token)
+      Helper.assign_current_user_custom_attributes(env, decoded_token, config.custom_attributes)
       Helper.assign_realm_roles(env, decoded_token)
       @app.call(env)
     end
@@ -43,5 +44,9 @@ module Keycloak
     def logger
       Keycloak.logger
     end
+
+    def config
+      Keycloak.config
+    end
   end
 end

data/lib/keycloak-api-rails/version.rb

@@ -1,3 +1,3 @@
 module Keycloak
-  VERSION = "0.8"
+  VERSION = "0.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak-api-rails
 version: !ruby/object:Gem::Version
-  version: '0.8'
+  version: '0.10'
 platform: ruby
 authors:
 - Lorent Lempereur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-25 00:00:00.000000000 Z
+date: 2019-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails