keycloak-admin 1.0.4 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ee26761041b21a26002eedbd5f204e031a81e3b46b2a0942e3007873a95fd87
-  data.tar.gz: 1933430211e65e88fc358b90dab200606e9b02e3870dc717ce0a57e977669e1c
+  metadata.gz: b1c9e5505dc0883709f4b37f86e2344d352d9994474c316e2f5dabef44494dfb
+  data.tar.gz: 8046d950cbd37f43afd97764339a581ca9f98ffd311189b7504e1144e9e3e1e0
 SHA512:
-  metadata.gz: f9a2863c392f7bf68fb3a044ac30fc5bd183dc0e467595dcbe3999bbb82dca75d15eaeccf108b0ed5a6da147292b80db78e45ff8d5cbcc978a607cac8f1a98d4
-  data.tar.gz: 163f9ccd4275159c64fb07e833413c40dc4f02f0d7dfced9300c4f776dade9ebb00184c7cfca72897dcc0ce9398ac772ee5e95cc007a2625f3f48ceca2cd3138
+  metadata.gz: '0875ad8a22ab4495faa6d21e842b6cf4f28cdf7fffdcf79cefd49e8d7c6178b8beb651f5e7ce8f8557c8b2431b8c07ffd482cca7710f53088a64ca1710eacfaf'
+  data.tar.gz: 23ab8ac413cd13cd94eec79ca45a7744a057d40b876af7c4e6432ef343cb5ca9a881182172eb8c97e842c4103fd248a8b2899d8e97998abcf043909e129df124

data/CHANGELOG.md

@@ -5,11 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.0.3] - 2022-03-11
+
+## [1.0.7] - 2022-03-13
+
+* Allow to use multiple `KeycloakAdmin::Client` in the same environment 
+
+## [1.0.6] - 2022-03-13
+
+* When serializing an array to JSON, force the serialization to use `to_json` for each element. In several contexts (e.g. Rails), `to_json` is not used.
+
+## [1.0.5] - 2022-03-11
 
 * Create `Client`
 * Create `Identity Provider` (Breaking change: `IdentityProviderRepresentation.configuration` has been renamed to `IdentityProviderRepresentation.config`)
 * Add `Identity Provider Mapping`
+* Find service account for a `Client`
 
 ## [1.0.1] - 2021-10-14
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    keycloak-admin (1.0.4)
+    keycloak-admin (1.0.6)
       http-cookie (~> 1.0, >= 1.0.3)
       rest-client (~> 2.0)
 
@@ -39,7 +39,7 @@ GEM
     rspec-support (3.7.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.8)
+    unf_ext (0.0.8.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -12,7 +12,7 @@ This gem *does not* require Rails.
 For example, using `bundle`, add this line to your Gemfile.
 
 ```ruby
-gem "keycloak-admin", "1.0.4"
+gem "keycloak-admin", "1.0.7"
 ```
 
 ## Login

data/lib/keycloak-admin/client/client.rb

@@ -10,7 +10,7 @@ module KeycloakAdmin
     end
 
     def current_token
-      @current_token ||= KeycloakAdmin.realm(@configuration.client_realm_name).token.get
+      @current_token ||= KeycloakAdmin.create_client(@configuration, @configuration.client_realm_name).token.get
     end
 
     def headers
@@ -37,6 +37,16 @@ module KeycloakAdmin
       id
     end
 
+    def create_payload(value)
+      if value.nil?
+        ""
+      elsif value.kind_of?(Array)
+        "[#{value.map(&:to_json) * ','}]"
+      else
+        value.to_json
+      end
+    end
+
     private
 
     def http_error(response)

data/lib/keycloak-admin/client/client_client.rb

@@ -9,7 +9,7 @@ module KeycloakAdmin
     def save(client_representation)
       execute_http do
         RestClient::Resource.new(clients_url, @configuration.rest_client_options).post(
-          client_representation.to_json, headers
+          create_payload(client_representation), headers
         )
       end
     end
@@ -21,6 +21,13 @@ module KeycloakAdmin
       JSON.parse(response).map { |client_as_hash| ClientRepresentation.from_hash(client_as_hash) }
     end
 
+    def get_service_account_user(client_id)
+      response = execute_http do
+        RestClient::Resource.new(service_account_user_url(client_id), @configuration.rest_client_options).get(headers)
+      end
+      UserRepresentation.from_hash(JSON.parse(response))
+    end
+
     def clients_url(id=nil)
       if id
         "#{@realm_client.realm_admin_url}/clients/#{id}"
@@ -28,5 +35,9 @@ module KeycloakAdmin
         "#{@realm_client.realm_admin_url}/clients"
       end
     end
+
+    def service_account_user_url(client_id)
+      "#{clients_url(client_id)}/service-account-user"
+    end
   end
 end

data/lib/keycloak-admin/client/client_role_mappings_client.rb

@@ -16,7 +16,7 @@ module KeycloakAdmin
     def save(role_representation_list)
       execute_http do
         RestClient::Resource.new(base_url, @configuration.rest_client_options).post(
-          role_representation_list.to_json, headers
+          create_payload(role_representation_list), headers
         )
       end
     end

data/lib/keycloak-admin/client/group_client.rb

@@ -21,7 +21,7 @@ module KeycloakAdmin
     def save(group_representation)
       execute_http do
         RestClient::Resource.new(groups_url, @configuration.rest_client_options).post(
-          group_representation.to_json, headers
+          create_payload(group_representation), headers
         )
       end
     end

data/lib/keycloak-admin/client/identity_provider_client.rb

@@ -9,7 +9,7 @@ module KeycloakAdmin
     def create(identity_provider_representation)
       execute_http do
         RestClient::Resource.new(identity_providers_url, @configuration.rest_client_options).post(
-          identity_provider_representation.to_json, headers
+          create_payload(identity_provider_representation), headers
         )
       end
     end
@@ -17,7 +17,7 @@ module KeycloakAdmin
     def add_mapping(identity_provider_alias, identity_provider_mapping_representation)
       execute_http do
         RestClient::Resource.new(identity_provider_mappers_url(identity_provider_alias), @configuration.rest_client_options).post(
-          identity_provider_mapping_representation.to_json, headers
+          create_payload(identity_provider_mapping_representation), headers
         )
       end
     end

data/lib/keycloak-admin/client/realm_client.rb

@@ -22,7 +22,7 @@ module KeycloakAdmin
     def save(realm_representation)
       execute_http do
         RestClient::Resource.new(realm_list_url, @configuration.rest_client_options).post(
-          realm_representation.to_json, headers
+          create_payload(realm_representation), headers
         )
       end
     end
@@ -30,7 +30,7 @@ module KeycloakAdmin
     def update(realm_representation_body)
       execute_http do
         RestClient::Resource.new(realm_admin_url, @configuration.rest_client_options).put(
-          realm_representation_body.to_json, headers
+          create_payload(realm_representation_body), headers
         )
       end
     end

data/lib/keycloak-admin/client/role_client.rb

@@ -16,7 +16,7 @@ module KeycloakAdmin
     def save(role_representation)
       execute_http do
         RestClient::Resource.new(roles_url, @configuration.rest_client_options).post(
-          role_representation.to_json, headers
+          create_payload(role_representation), headers
         )
       end
     end

data/lib/keycloak-admin/client/role_mapper_client.rb

@@ -8,7 +8,7 @@ module KeycloakAdmin
     def save_realm_level(role_representation_list)
       execute_http do
         RestClient::Resource.new(realm_level_url, @configuration.rest_client_options).post(
-          role_representation_list.to_json, headers
+          create_payload(role_representation_list), headers
         )
       end
     end

data/lib/keycloak-admin/client/user_client.rb

@@ -14,7 +14,7 @@ module KeycloakAdmin
     def save(user_representation)
       execute_http do
         RestClient::Resource.new(users_url, @configuration.rest_client_options).post(
-          user_representation.to_json, headers
+          create_payload(user_representation), headers
         )
       end
       user_representation
@@ -25,7 +25,7 @@ module KeycloakAdmin
         @configuration.rest_client_options.merge(
           method: :put,
           url: users_url(user_id),
-          payload: user_representation_body.to_json,
+          payload: create_payload(user_representation_body),
           headers: headers
         )
       )
@@ -120,7 +120,7 @@ module KeycloakAdmin
     def execute_actions_email(user_id, actions=[], lifespan=nil)
       execute_http do
         lifespan_param = lifespan.nil? ? "" : "lifespan=#{lifespan.seconds}"
-        RestClient.put("#{execute_actions_email_url(user_id)}?#{lifespan_param}", actions.to_json, headers)
+        RestClient.put("#{execute_actions_email_url(user_id)}?#{lifespan_param}", create_payload(actions), headers)
       end
       user_id
     end

data/lib/keycloak-admin/representation/protocol_mapper_representation.rb

@@ -4,15 +4,15 @@ module KeycloakAdmin
                   :id,
                   :name,
                   :protocol,
-                  :protocolMapper
+                  :protocol_mapper
 
     def self.from_hash(hash)
-      rep                = new
-      rep.id             = hash["id"]
-      rep.config         = hash["config"]
-      rep.name           = hash["name"]
-      rep.protocol       = hash["protocol"]
-      rep.protocolMapper = hash["protocolMapper"]
+      rep                 = new
+      rep.id              = hash["id"]
+      rep.config          = hash["config"]
+      rep.name            = hash["name"]
+      rep.protocol        = hash["protocol"]
+      rep.protocol_mapper = hash["protocolMapper"]
       rep
     end
   end

data/lib/keycloak-admin/version.rb

@@ -1,3 +1,3 @@
 module KeycloakAdmin
-  VERSION = "1.0.4"
+  VERSION = "1.0.7"
 end

data/lib/keycloak-admin.rb

@@ -42,7 +42,11 @@ module KeycloakAdmin
   end
 
   def self.realm(realm_name)
-    RealmClient.new(@configuration, realm_name)
+    create_client(@configuration, realm_name)
+  end
+
+  def self.create_client(configuration, realm_name)
+    RealmClient.new(configuration, realm_name)
   end
 
   def self.logger

data/spec/representation/protocol_mapper_representation_spec.rb

@@ -0,0 +1,57 @@
+RSpec.describe KeycloakAdmin::ProtocolMapperRepresentation do
+  describe "#to_json" do
+    before(:each) do
+      @mapper = KeycloakAdmin::ProtocolMapperRepresentation.from_hash(
+        {
+          "id" => "hello",
+          "name" => "abcd",
+          "protocol" => "openid-connect",
+          "protocolMapper" => "oidc-hardcoded-claim-mapper",
+          "consentRequired" => false,
+          "config" => {
+            "claim.value" => "123456",
+            "userinfo.token.claim" => "false",
+            "id.token.claim" => "false",
+            "access.token.claim" => "true",
+            "claim.name" => "abcd",
+            "jsonType.label" => "String",
+            "access.tokenResponse.claim" => "false"
+          }
+        }
+      )
+    end
+
+    it "can convert to json" do
+      expect(@mapper.to_json).to eq "{\"id\":\"hello\",\"config\":{\"claim.value\":\"123456\",\"userinfo.token.claim\":\"false\",\"id.token.claim\":\"false\",\"access.token.claim\":\"true\",\"claim.name\":\"abcd\",\"jsonType.label\":\"String\",\"access.tokenResponse.claim\":\"false\"},\"name\":\"abcd\",\"protocol\":\"openid-connect\",\"protocolMapper\":\"oidc-hardcoded-claim-mapper\"}"
+    end
+  end
+
+  describe "array#to_json" do
+    before(:each) do
+      @mapper = [
+        KeycloakAdmin::ProtocolMapperRepresentation.from_hash(
+          {
+            "id" => "hello",
+            "name" => "abcd",
+            "protocol" => "openid-connect",
+            "protocolMapper" => "oidc-hardcoded-claim-mapper",
+            "consentRequired" => false,
+            "config" => {
+              "claim.value" => "123456",
+              "userinfo.token.claim" => "false",
+              "id.token.claim" => "false",
+              "access.token.claim" => "true",
+              "claim.name" => "abcd",
+              "jsonType.label" => "String",
+              "access.tokenResponse.claim" => "false"
+            }
+          }
+        )
+      ]
+    end
+
+    it "can convert to json" do
+      expect(@mapper.to_json).to eq "[{\"id\":\"hello\",\"config\":{\"claim.value\":\"123456\",\"userinfo.token.claim\":\"false\",\"id.token.claim\":\"false\",\"access.token.claim\":\"true\",\"claim.name\":\"abcd\",\"jsonType.label\":\"String\",\"access.tokenResponse.claim\":\"false\"},\"name\":\"abcd\",\"protocol\":\"openid-connect\",\"protocolMapper\":\"oidc-hardcoded-claim-mapper\"}]"
+    end
+  end
+end

data/spec/representation/role_representation_spec.rb

@@ -0,0 +1,37 @@
+RSpec.describe KeycloakAdmin::RoleRepresentation do
+  describe "#to_json" do
+    before(:each) do
+      @mapper = KeycloakAdmin::RoleRepresentation.from_hash(
+        {
+          "id" => "bb79fb10-a7b4-4728-a662-82a4de7844a3",
+          "name" => "abcd",
+          "composite" => true,
+          "clientRole" => false
+        }
+      )
+    end
+
+    it "can convert to json" do
+      expect(@mapper.to_json).to eq "{\"id\":\"bb79fb10-a7b4-4728-a662-82a4de7844a3\",\"name\":\"abcd\",\"composite\":true,\"clientRole\":false}"
+    end
+  end
+
+  describe "array#to_json" do
+    before(:each) do
+      @mappers = [
+        KeycloakAdmin::RoleRepresentation.from_hash(
+          {
+            "id" => "bb79fb10-a7b4-4728-a662-82a4de7844a3",
+            "name" => "abcd",
+            "composite" => true,
+            "clientRole" => false
+          }
+        )
+      ]
+    end
+
+    it "can convert to json" do
+      expect(@mappers.to_json).to eq "[{\"id\":\"bb79fb10-a7b4-4728-a662-82a4de7844a3\",\"name\":\"abcd\",\"composite\":true,\"clientRole\":false}]"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak-admin
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.7
 platform: ruby
 authors:
 - Lorent Lempereur
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-cookie
@@ -136,6 +136,8 @@ files:
 - spec/representation/identity_provider_mapper_representation_spec.rb
 - spec/representation/identity_provider_representation_spec.rb
 - spec/representation/impersonation_representation_spec.rb
+- spec/representation/protocol_mapper_representation_spec.rb
+- spec/representation/role_representation_spec.rb
 - spec/representation/user_representation_spec.rb
 - spec/resource/group_resource_spec.rb
 - spec/resource/user_resource_spec.rb