keycloak-admin 1.0.3 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a677bd275fc1500031ac0a13adcc312a6eff5da4fc662292d616c9a3bb4d753c
-  data.tar.gz: 8600a6ceb17f1d9635a331d442c4696e7cdd672aa411136f63f42c9387b34158
+  metadata.gz: a78897f6f30b684a57e9233d436c4cd338061729abc161e0afd8c904ca8890d7
+  data.tar.gz: 75c438cf89337f0823d0cd4b7f0379dc5d40dcf090309b319e02ee5145b92f6c
 SHA512:
-  metadata.gz: 3716f93590b60ce198c746b606b63b0e6fb010544005792ec4f3d6b5e3cbcec47bc63ea689d330f68ba3befed19387896f11e01667f501180d9ada4d147f9fcf
-  data.tar.gz: 89c40af6666c161b44801bba87cad4ceca1bf73bc3d211be8755a00e334a56748a4495cc436d726c8d84e4ce155458437600cd35ef24f9b280a550ae3cc137ec
+  metadata.gz: e1f43d6a122d6e5ce869a38773293fc8bb913865c4febef40904cb660b7440dede79fdb477476bf4f73b001999fc4adb4eb662677b74b8c908baa0370538a09e
+  data.tar.gz: bc883a362f07cbec20df4ae07fd0fbabe5b5d9056fc0df443df65d768c0887dd33a0b0c3127b45efa80f5d60231a09cab3e45358cf969ea097b2bfa5173df431

data/CHANGELOG.md

@@ -5,11 +5,16 @@ 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.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.3)
+    keycloak-admin (1.0.5)
       http-cookie (~> 1.0, >= 1.0.3)
       rest-client (~> 2.0)
 

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.3"
+gem "keycloak-admin", "1.0.6"
 ```
 
 ## Login

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

@@ -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,
-                  :protocol_mapper
+                  :protocolMapper
 
     def self.from_hash(hash)
-      rep                 = new
-      rep.id              = hash["id"]
-      rep.config          = hash["config"]
-      rep.name            = hash["name"]
-      rep.protocol        = hash["protocol"]
-      rep.protocol_mapper = hash["protocolMapper"]
+      rep                = new
+      rep.id             = hash["id"]
+      rep.config         = hash["config"]
+      rep.name           = hash["name"]
+      rep.protocol       = hash["protocol"]
+      rep.protocolMapper = hash["protocolMapper"]
       rep
     end
   end

data/lib/keycloak-admin/version.rb

@@ -1,3 +1,3 @@
 module KeycloakAdmin
-  VERSION = "1.0.3"
+  VERSION = "1.0.6"
 end

data/spec/representation/client_representation_spec.rb

@@ -1,4 +1,4 @@
-RSpec.describe KeycloakAdmin::UserRepresentation do
+RSpec.describe KeycloakAdmin::ClientRepresentation do
   describe "#to_json" do
     before(:each) do
       @client = KeycloakAdmin::ClientRepresentation.from_hash(

data/spec/representation/identity_provider_mapper_representation_spec.rb

@@ -1,4 +1,4 @@
-RSpec.describe KeycloakAdmin::UserRepresentation do
+RSpec.describe KeycloakAdmin::IdentityProviderMapperRepresentation do
   describe "#to_json" do
     before(:each) do
       @mapper = KeycloakAdmin::IdentityProviderMapperRepresentation.from_hash(

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak-admin
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.6
 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,7 @@ 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/user_representation_spec.rb
 - spec/resource/group_resource_spec.rb
 - spec/resource/user_resource_spec.rb