keycloak-admin 2.0.1 → 2.0.2

data/spec/representation/identity_provider_representation_spec.rb

@@ -1,113 +0,0 @@
-RSpec.describe KeycloakAdmin::IdentityProviderRepresentation do
-  describe "#from_hash" do
-    before(:each) do
-      json = <<-JSON
-      {
-        "alias": "acme",
-        "displayName": "ACME",
-        "internalId": "20fea77e-ae3d-411e-9467-2b3a20cd3e6d",
-        "providerId": "saml",
-        "enabled": true,
-        "updateProfileFirstLoginMode": "on",
-        "trustEmail": true,
-        "storeToken": false,
-        "addReadTokenRoleOnCreate": false,
-        "authenticateByDefault": false,
-        "linkOnly": false,
-        "firstBrokerLoginFlowAlias": "first broker login",
-        "config": {
-          "hideOnLoginPage": "",
-          "validateSignature": "true",
-          "samlXmlKeyNameTranformer": "KEY_ID",
-          "signingCertificate": "",
-          "postBindingLogout": "false",
-          "nameIDPolicyFormat": "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
-          "postBindingResponse": "true",
-          "backchannelSupported": "",
-          "signatureAlgorithm": "RSA_SHA256",
-          "wantAssertionsEncrypted": "false",
-          "xmlSigKeyInfoKeyNameTransformer": "CERT_SUBJECT",
-          "useJwksUrl": "true",
-          "wantAssertionsSigned": "true",
-          "postBindingAuthnRequest": "true",
-          "forceAuthn": "",
-          "wantAuthnRequestsSigned": "true",
-          "singleSignOnServiceUrl": "https://login.microsoftonline.com/test/saml2",
-          "addExtensionsElementWithKeyInfo": "false"
-        }
-      }
-      JSON
-      payload            = JSON.parse(json)
-      @identity_provider = KeycloakAdmin::IdentityProviderRepresentation.from_hash(payload)
-    end
-
-    it "parses the alias" do
-      expect(@identity_provider.alias).to eq "acme"
-    end
-
-    it "parses the display name" do
-      expect(@identity_provider.display_name).to eq "ACME"
-    end
-
-    it "parses the internalId" do
-      expect(@identity_provider.internal_id).to eq "20fea77e-ae3d-411e-9467-2b3a20cd3e6d"
-    end
-
-    it "parses the provider id" do
-      expect(@identity_provider.provider_id).to eq "saml"
-    end
-
-    it "parses the enabled" do
-      expect(@identity_provider.enabled).to eq true
-    end
-
-    it "parses the update_profile_first_login_mode" do
-      expect(@identity_provider.update_profile_first_login_mode).to eq "on"
-    end
-
-    it "parses the trust_email" do
-      expect(@identity_provider.trust_email).to eq true
-    end
-
-    it "parses the store_token" do
-      expect(@identity_provider.store_token).to eq false
-    end
-
-    it "parses the add_read_token_role_on_create" do
-      expect(@identity_provider.add_read_token_role_on_create).to eq false
-    end
-
-    it "parses the authenticate_by_default" do
-      expect(@identity_provider.authenticate_by_default).to eq false
-    end
-
-    it "parses the link_only" do
-      expect(@identity_provider.link_only).to eq false
-    end
-    
-    it "parses the first_broker_login_flow_alias" do
-      expect(@identity_provider.first_broker_login_flow_alias).to eq "first broker login"
-    end
-
-    it "parses the configuration as a hash with camel properties" do
-      expect(@identity_provider.config["hideOnLoginPage"]).to eq ""
-      expect(@identity_provider.config["validateSignature"]).to eq "true"
-      expect(@identity_provider.config["samlXmlKeyNameTranformer"]).to eq "KEY_ID"
-      expect(@identity_provider.config["signingCertificate"]).to eq ""
-      expect(@identity_provider.config["postBindingLogout"]).to eq "false"
-      expect(@identity_provider.config["nameIDPolicyFormat"]).to eq "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"
-      expect(@identity_provider.config["postBindingResponse"]).to eq "true"
-      expect(@identity_provider.config["backchannelSupported"]).to eq ""
-      expect(@identity_provider.config["signatureAlgorithm"]).to eq "RSA_SHA256"
-      expect(@identity_provider.config["wantAssertionsEncrypted"]).to eq "false"
-      expect(@identity_provider.config["xmlSigKeyInfoKeyNameTransformer"]).to eq "CERT_SUBJECT"
-      expect(@identity_provider.config["useJwksUrl"]).to eq "true"
-      expect(@identity_provider.config["wantAssertionsSigned"]).to eq "true"
-      expect(@identity_provider.config["postBindingAuthnRequest"]).to eq "true"
-      expect(@identity_provider.config["forceAuthn"]).to eq ""
-      expect(@identity_provider.config["wantAuthnRequestsSigned"]).to eq "true"
-      expect(@identity_provider.config["singleSignOnServiceUrl"]).to eq "https://login.microsoftonline.com/test/saml2"
-      expect(@identity_provider.config["addExtensionsElementWithKeyInfo"]).to eq "false"
-    end
-  end
-end

data/spec/representation/impersonation_representation_spec.rb

@@ -1,163 +0,0 @@
-RSpec.describe KeycloakAdmin::ImpersonationRepresentation do
-  describe "#parse_set_cookie_string" do
-
-    let(:origin)            { "http://auth.service.io" }
-    let(:set_cookie_string) { "" }
-
-    before(:each) do
-      @cookie = KeycloakAdmin::ImpersonationRepresentation.parse_set_cookie_string(set_cookie_string, origin)
-    end
-
-    shared_context "common properties are read properly" do
-      it "parses its domain property" do
-        expect(@cookie.domain).to eq "auth.service.io"
-      end
-
-      it "parses its for_domain property" do
-        expect(@cookie.for_domain).to be false
-      end
-
-      it "parses its Path property" do
-        expect(@cookie.path).to eq "/auth/realms/a-realm"
-      end
-
-      it "parses its Secure property" do
-        expect(@cookie.secure).to be false
-      end
-    end
-
-    context "when result is an expiring empty KEYCLOAK_IDENTITY" do
-      let(:set_cookie_string) { "KEYCLOAK_IDENTITY=; Version=1; Comment=Expiring cookie; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Max-Age=0; Path=/auth/realms/a-realm; HttpOnly" }
-      
-      include_examples "common properties are read properly"
-
-      it "parses its name property" do
-        expect(@cookie.name).to eq "KEYCLOAK_IDENTITY"
-      end
-
-      it "parses its value property" do
-        expect(@cookie.value).to eq ""
-      end
-
-      it "parses its Expires property" do
-        expect(@cookie.expires).to be <= Time.now
-      end
-
-      it "parses its Max-Age property" do
-        expect(@cookie.max_age).to eq 0
-      end
-
-      it "parses its HttpOnly property" do
-        expect(@cookie.httponly).to be true
-      end
-    end
-
-
-    context "when result is an expiring empty KEYCLOAK_SESSION" do
-      let(:set_cookie_string) { "KEYCLOAK_SESSION=; Version=1; Comment=Expiring cookie; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Max-Age=0; Path=/auth/realms/a-realm" }
-      
-      include_examples "common properties are read properly"
-
-      it "parses its name property" do
-        expect(@cookie.name).to eq "KEYCLOAK_SESSION"
-      end
-
-      it "parses its value property" do
-        expect(@cookie.value).to eq ""
-      end
-
-      it "parses its Expires property" do
-        expect(@cookie.expires).to be <= Time.now
-      end
-
-      it "parses its Max-Age property" do
-        expect(@cookie.max_age).to eq 0
-      end
-
-      it "parses its HttpOnly property" do
-        expect(@cookie.httponly).to be false
-      end
-    end
-
-
-    context "when result is an expiring empty KEYCLOAK_REMEMBER_ME" do
-      let(:set_cookie_string) { "KEYCLOAK_REMEMBER_ME=; Version=1; Comment=Expiring cookie; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Max-Age=0; Path=/auth/realms/a-realm; HttpOnly" }
-      
-      include_examples "common properties are read properly"
-
-      it "parses its name property" do
-        expect(@cookie.name).to eq "KEYCLOAK_REMEMBER_ME"
-      end
-
-      it "parses its value property" do
-        expect(@cookie.value).to eq ""
-      end
-
-      it "parses its Expires property" do
-        expect(@cookie.expires).to be <= Time.now
-      end
-
-      it "parses its Max-Age property" do
-        expect(@cookie.max_age).to eq 0
-      end
-
-      it "parses its HttpOnly property" do
-        expect(@cookie.httponly).to be true
-      end
-    end
-
-    context "when result is a new KEYCLOAK_IDENTITY" do
-      let(:set_cookie_string) { "KEYCLOAK_IDENTITY=eyJhbGciOiJIUzI1NiIsImtpZCIgOiAiMDQyMTcwMWItY2I2Ny00YzQ4LWIzZWYtMDBlMDhhMmE4MjNjIn0.eyJqdGkiOiI5ZTEyODc3MC1mN2U1LTQ0OWYtYWMzYi03OTAzN2Q5NDBhOTMiLCJleHAiOjE1MTY2ODE2ODIsIm5iZiI6MCwiaWF0IjoxNTE2NjQ1NjgyLCJpc3MiOiJodHRwOi8vYXV0aDo4MDgwL2F1dGgvcmVhbG1zL2NvbW11dHkiLCJzdWIiOiI0NGM1MzdmMi1iMzBiLTRlZTctYjI4Ni1lZTY2NjI2NDcwYWMiLCJhdXRoX3RpbWUiOjAsInNlc3Npb25fc3RhdGUiOiI3ZDI5NTJlZS0xMjllLTRmOGQtYmFjNy1jMWE0YWUxNGRjY2QiLCJyZXNvdXJjZV9hY2Nlc3MiOnt9LCJzdGF0ZV9jaGVja2VyIjoiUEdXZVdXc3hMRmN3WG1QelFmMGxBQTJrN1V3Skg3UUlHU0lrN3hmWUFEbyJ9.Hw9EM1rZLXkUfE97tfS8jw8MFogfMoGpT34yoMupK3E; Version=1; Path=/auth/realms/a-realm; HttpOnly" }
-      
-      include_examples "common properties are read properly"
-
-      it "parses its name property" do
-        expect(@cookie.name).to eq "KEYCLOAK_IDENTITY"
-      end
-
-      it "parses its value property" do
-        expect(@cookie.value).to eq "eyJhbGciOiJIUzI1NiIsImtpZCIgOiAiMDQyMTcwMWItY2I2Ny00YzQ4LWIzZWYtMDBlMDhhMmE4MjNjIn0.eyJqdGkiOiI5ZTEyODc3MC1mN2U1LTQ0OWYtYWMzYi03OTAzN2Q5NDBhOTMiLCJleHAiOjE1MTY2ODE2ODIsIm5iZiI6MCwiaWF0IjoxNTE2NjQ1NjgyLCJpc3MiOiJodHRwOi8vYXV0aDo4MDgwL2F1dGgvcmVhbG1zL2NvbW11dHkiLCJzdWIiOiI0NGM1MzdmMi1iMzBiLTRlZTctYjI4Ni1lZTY2NjI2NDcwYWMiLCJhdXRoX3RpbWUiOjAsInNlc3Npb25fc3RhdGUiOiI3ZDI5NTJlZS0xMjllLTRmOGQtYmFjNy1jMWE0YWUxNGRjY2QiLCJyZXNvdXJjZV9hY2Nlc3MiOnt9LCJzdGF0ZV9jaGVja2VyIjoiUEdXZVdXc3hMRmN3WG1QelFmMGxBQTJrN1V3Skg3UUlHU0lrN3hmWUFEbyJ9.Hw9EM1rZLXkUfE97tfS8jw8MFogfMoGpT34yoMupK3E"
-      end
-
-      it "parses its Expires property" do
-        expect(@cookie.expires).to be_nil
-      end
-
-      it "parses its Max-Age property" do
-        expect(@cookie.max_age).to be nil
-      end
-
-      it "parses its HttpOnly property" do
-        expect(@cookie.httponly).to be true
-      end
-    end
-
-    context "when result is a new KEYCLOAK_SESSION" do
-      let(:set_cookie_string) { "KEYCLOAK_SESSION=commuty/44c537f2-b30b-4ee7-b286-ee66626470ac/cd79f3c2-7cee-4c4e-980b-43293aaaff88; Version=1; Expires=Tue, 23-Jan-2018 23:56:32 GMT; Max-Age=36000; Path=/auth/realms/a-realm" }
-      
-      include_examples "common properties are read properly"
-
-      it "parses its name property" do
-        expect(@cookie.name).to eq "KEYCLOAK_SESSION"
-      end
-
-      it "parses its value property" do
-        expect(@cookie.value).to eq "commuty/44c537f2-b30b-4ee7-b286-ee66626470ac/cd79f3c2-7cee-4c4e-980b-43293aaaff88"
-      end
-
-      it "parses its Expires property" do
-        expect(@cookie.expires).to_not be_nil
-      end
-
-      it "parses its Max-Age property" do
-        expect(@cookie.max_age).to be 36000
-      end
-
-      it "parses its HttpOnly property" do
-        expect(@cookie.httponly).to be false
-      end
-    end
-  end
-end
-
-

data/spec/representation/organization_representation_spec.rb

@@ -1,64 +0,0 @@
-
-RSpec.describe KeycloakAdmin::OrganizationRepresentation do
-  describe ".from_json" do
-    it "parse a single organization" do
-      json_payload = <<-'payload'
-        {
-          "id": "8f6e474e-e688-4bec-99ba-5dc862594f4b",
-          "name": "My organization",
-          "alias": "myorg",
-          "enabled": true,
-          "description": "A single organization",
-          "redirectUrl": "https://myapp.acme.com",
-          "attributes": {
-              "advanced": [
-                  "yes"
-              ],
-              "days": [
-                "monday",
-                "friday"
-              ]
-          },
-          "domains": [
-            {
-              "name": "hello.com",
-              "verified": false
-            },
-            {
-              "name": "gmail.com",
-              "verified": true
-            }
-          ]
-        }
-      payload
-
-      organization = described_class.from_json(json_payload)
-      expect(organization).to be
-      expect(organization).to be_a described_class
-      expect(organization.id).to eq "8f6e474e-e688-4bec-99ba-5dc862594f4b"
-      expect(organization.name).to eq "My organization"
-      expect(organization.alias).to eq "myorg"
-      expect(organization.description).to eq "A single organization"
-      expect(organization.redirect_url).to eq "https://myapp.acme.com"
-      expect(organization.enabled).to be true
-      
-      expect(organization.domains.size).to eq 2
-      expect(organization.domains[0]).to be_a KeycloakAdmin::OrganizationDomainRepresentation
-      expect(organization.domains[0].name).to eq "hello.com"
-      expect(organization.domains[0].verified).to be false
-      expect(organization.domains[1]).to be_a KeycloakAdmin::OrganizationDomainRepresentation
-      expect(organization.domains[1].name).to eq "gmail.com"
-      expect(organization.domains[1].verified).to be true
-
-      expect(organization.attributes.size).to eq 2
-      expect(organization.attributes["advanced"].size).to eq 1
-      expect(organization.attributes["advanced"][0]).to eq "yes"
-      expect(organization.attributes["days"].size).to eq 2
-      expect(organization.attributes["days"][0]).to eq "monday"
-      expect(organization.attributes["days"][1]).to eq "friday"
-
-      expect(organization.members.size).to eq 0
-      expect(organization.identity_providers.size).to eq 0
-    end
-  end
-end

data/spec/representation/protocol_mapper_representation_spec.rb

@@ -1,57 +0,0 @@
-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

@@ -1,37 +0,0 @@
-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,\"containerId\":null}"
-    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,\"containerId\":null}]"
-    end
-  end
-end

data/spec/representation/session_representation_spec.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe KeycloakAdmin::SessionRepresentation do
-  describe '.from_hash' do
-    it 'converts json response to class structure' do
-      rep = described_class.from_hash({
-        'username' => 'test_username',
-        'userId' => '95985b21-d884-4bbd-b852-cb8cd365afc2',
-        'ipAddress' => '1.1.1.1',
-        'start' => 12345678
-      })
-      expect(rep.user_id).to eq '95985b21-d884-4bbd-b852-cb8cd365afc2'
-      expect(rep).to be_a described_class
-    end
-  end
-end

data/spec/representation/user_representation_spec.rb

@@ -1,15 +0,0 @@
-RSpec.describe KeycloakAdmin::UserRepresentation do
-  describe "#to_json" do
-    before(:each) do
-      @user = KeycloakAdmin::UserRepresentation.from_hash(
-        "username" => "test_username",
-        "createdTimestamp" => Time.at(1559836000).to_i,
-        "enabled" => true
-      )
-    end
-
-    it "can convert to json" do
-      expect(@user.to_json).to eq '{"id":null,"createdTimestamp":1559836000,"origin":null,"username":"test_username","email":null,"enabled":true,"emailVerified":null,"firstName":null,"lastName":null,"attributes":null,"requiredActions":[],"totp":false,"credentials":[],"federatedIdentities":[]}'
-    end
-  end
-end

data/spec/resource/group_resource_spec.rb

@@ -1,14 +0,0 @@
-RSpec.describe KeycloakAdmin::GroupResource do
-  describe "#resource_url" do
-    let(:realm_name) { "valid-realm" }
-    let(:group_id)   { "95985b21-d884-4bbd-b852-cb8cd365afc2" }
-
-    before(:each) do
-      @built_url = KeycloakAdmin.realm(realm_name).group(group_id).resource_url
-    end
-
-    it "return a proper url" do
-      expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/groups/95985b21-d884-4bbd-b852-cb8cd365afc2"
-    end
-  end
-end

data/spec/resource/user_resource_spec.rb

@@ -1,14 +0,0 @@
-RSpec.describe KeycloakAdmin::UserResource do
-  describe "#resource_url" do
-    let(:realm_name) { "valid-realm" }
-    let(:user_id)    { "95985b21-d884-4bbd-b852-cb8cd365afc2" }
-
-    before(:each) do
-      @built_url = KeycloakAdmin.realm(realm_name).user(user_id).resource_url
-    end
-
-    it "return a proper url" do
-      expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/users/95985b21-d884-4bbd-b852-cb8cd365afc2"
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,36 +0,0 @@
-require_relative "../lib/keycloak-admin"
-
-require "byebug"
-
-def configure
-  KeycloakAdmin.configure do |config|
-    config.server_url          = "http://auth.service.io/auth"
-    config.server_domain       = "auth.service.io"
-    config.client_id           = "admin-cli"
-    config.client_secret       = "aaaaaaaa"
-    config.client_realm_name   = "master2"
-    config.use_service_account = true
-  end
-end
-
-RSpec.configure do |config|
-  config.expect_with :rspec do |expectations|
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  configure
-
-  # KeycloakAdmin.config is a global set up once for the whole suite (see 'configure'
-  # above), not per example, so a token cached in one example would otherwise leak into
-  # the next one and silently skip its stub_token_client expectations.
-  config.before(:each) do
-    KeycloakAdmin.config.clear_cached_token!
-  end
-end
-
-def stub_token_client
-  allow_any_instance_of(KeycloakAdmin::TokenClient).to receive(:get).and_return KeycloakAdmin::TokenRepresentation.new(
-    "test_access_token", "token_type", 3600, "refresh_token",
-    "refresh_expires_in", "id_token", "not_before_policy", "session_state"
-  )
-end