keycloak-admin 2.0.0 → 2.0.2

data/spec/client/client_spec.rb

@@ -1,48 +0,0 @@
-RSpec.describe KeycloakAdmin::Client do
-  describe "#server_url" do
-    def client_with_server_url(server_url)
-      configuration = KeycloakAdmin::Configuration.new
-      configuration.server_url = server_url
-      KeycloakAdmin::Client.new(configuration)
-    end
-
-    it "returns the configured url untouched when it has no trailing slash" do
-      expect(client_with_server_url("http://auth.service.io/auth").server_url).to eql "http://auth.service.io/auth"
-    end
-
-    it "strips a trailing slash so built paths stay normalized" do
-      expect(client_with_server_url("http://auth.service.io/auth/").server_url).to eql "http://auth.service.io/auth"
-    end
-
-    it "strips repeated trailing slashes" do
-      expect(client_with_server_url("http://localhost:8080///").server_url).to eql "http://localhost:8080"
-    end
-
-    it "returns nil when no url is configured" do
-      expect(client_with_server_url(nil).server_url).to be_nil
-    end
-  end
-
-  describe "#execute_http" do
-    let(:realm_name) { "valid-realm" }
-    before(:each) do
-      @client = KeycloakAdmin::Client.new(KeycloakAdmin.config)
-    end
-
-    it "handles timeout" do
-      expect do
-        @client.execute_http do
-          raise Faraday::TimeoutError.new
-        end
-      end.to raise_error(Faraday::TimeoutError)
-    end
-
-    it "handles response exception" do
-      expect do
-        @client.execute_http do
-          raise Faraday::ServerError.new("boom", status: 500, body: "Server error")
-        end
-      end.to raise_error("Keycloak: The request failed with response code 500 and message: Server error")
-    end
-  end
-end

data/spec/client/configurable_token_client_spec.rb

@@ -1,34 +0,0 @@
-RSpec.describe KeycloakAdmin::ConfigurableTokenClient do
-  describe "#initialize" do
-    context "when realm_name is defined" do
-      let(:realm_name) { "master" }
-      it "does not raise any error" do
-        expect {
-          KeycloakAdmin.realm(realm_name).configurable_token
-        }.to_not raise_error
-      end
-    end
-
-    context "when realm_name is not defined" do
-      let(:realm_name) { nil }
-      it "raises any error" do
-        expect {
-          KeycloakAdmin.realm(realm_name).configurable_token
-        }.to raise_error(ArgumentError)
-      end
-    end
-  end
-
-  describe "#token_url" do
-    let(:realm_name) { "valid-realm" }
-    let(:user_id)    { nil }
-
-    before(:each) do
-      @built_url = KeycloakAdmin.realm(realm_name).configurable_token.token_url
-    end
-
-    it "return a proper url with the realm name" do
-      expect(@built_url).to eq "http://auth.service.io/auth/realms/valid-realm/configurable-token"
-    end
-  end
-end

data/spec/client/group_client_spec.rb

@@ -1,328 +0,0 @@
-RSpec.describe KeycloakAdmin::GroupClient do
-  describe "#groups_url" do
-    let(:realm_name) { "valid-realm" }
-    let(:group_id)    { nil }
-
-    before(:each) do
-      @built_url = KeycloakAdmin.realm(realm_name).groups.groups_url(group_id)
-    end
-
-    context "when group_id is not defined" do
-      let(:group_id) { nil }
-      it "return a proper url without group id" do
-        expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/groups"
-      end
-    end
-
-    context "when group_id is defined" do
-      let(:group_id) { "95985b21-d884-4bbd-b852-cb8cd365afc2" }
-      it "return a proper url with the group id" do
-        expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/groups/95985b21-d884-4bbd-b852-cb8cd365afc2"
-      end
-    end
-  end
-
-  describe "#get" do
-    let(:realm_name) { "valid-realm" }
-
-    before(:each) do
-      @group_client = KeycloakAdmin.realm(realm_name).groups
-
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return '{"id":"test_group_id","name":"test_group_name"}'
-    end
-
-    it "get a group" do
-      group = @group_client.get("test_group_id")
-      expect(group.id).to eq "test_group_id"
-      expect(group.name).to eq "test_group_name"
-    end
-
-    it "passes rest client options" do
-      faraday_options = {timeout: 10}
-      allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:faraday_options).and_return faraday_options
-
-      expect(KeycloakAdmin::Resource).to receive(:new).with(
-        "http://auth.service.io/auth/admin/realms/valid-realm/groups/test_group_id", faraday_options).and_call_original
-
-      group = @group_client.get("test_group_id")
-      expect(group.id).to eq "test_group_id"
-      expect(group.name).to eq "test_group_name"
-    end
-  end
-
-  describe "#list" do
-    let(:realm_name) { "valid-realm" }
-
-    before(:each) do
-      @group_client = KeycloakAdmin.realm(realm_name).groups
-
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return '[{"id":"test_group_id","name":"test_group_name"}]'
-    end
-
-    it "lists groups" do
-      groups = @group_client.list
-      expect(groups.length).to eq 1
-      expect(groups[0].name).to eq "test_group_name"
-    end
-
-    it "passes rest client options" do
-      faraday_options = {timeout: 10}
-      allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:faraday_options).and_return faraday_options
-
-      expect(KeycloakAdmin::Resource).to receive(:new).with(
-        "http://auth.service.io/auth/admin/realms/valid-realm/groups", faraday_options).and_call_original
-
-      groups = @group_client.list
-      expect(groups.length).to eq 1
-      expect(groups[0].name).to eq "test_group_name"
-    end
-  end
-
-
-  describe "#children" do
-    let(:realm_name) { "valid-realm" }
-
-    before(:each) do
-      @group_client = KeycloakAdmin.realm(realm_name).groups
-
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return '[{"id":"test_group_id","name":"test_group_name"}]'
-    end
-
-    it "lists children groups" do
-      groups = @group_client.children("parent_group_id")
-      expect(groups.length).to eq 1
-      expect(groups[0].name).to eq "test_group_name"
-    end
-
-    it "passes rest client options" do
-      faraday_options = {timeout: 10}
-      allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:faraday_options).and_return faraday_options
-
-      expect(KeycloakAdmin::Resource).to receive(:new).with(
-        "http://auth.service.io/auth/admin/realms/valid-realm/groups/parent_group_id/children", faraday_options).and_call_original
-
-      groups = @group_client.children("parent_group_id")
-      expect(groups.length).to eq 1
-      expect(groups[0].name).to eq "test_group_name"
-    end
-  end
-
-  describe "#save" do
-    let(:realm_name) { "valid-realm" }
-
-    before(:each) do
-      @group_client = KeycloakAdmin.realm(realm_name).groups
-
-      stub_token_client
-    end
-
-    context "when the group does not exist" do
-      let(:group) { KeycloakAdmin::GroupRepresentation.from_hash(
-        "name" => "test_group_name"
-      )}
-
-      before do
-        response = double
-        allow(response).to receive(:headers).and_return(
-          { location: 'http://auth.service.io/auth/admin/realms/valid-realm/groups/be061c48-6edd-4783-a726-1a57d4bfa22b' }
-        )
-
-        expect_any_instance_of(KeycloakAdmin::Resource).to receive(:post).with(group.to_json, anything).and_return response
-      end
-
-      it "saves a group" do
-        @group_client.save(group)
-      end
-
-      it "passes rest client options" do
-        faraday_options = {timeout: 10}
-        allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:faraday_options).and_return faraday_options
-
-        expect(KeycloakAdmin::Resource).to receive(:new).with(
-          "http://auth.service.io/auth/admin/realms/valid-realm/groups", faraday_options).and_call_original
-
-        @group_client.save(group)
-      end
-    end
-
-    context "when the group already exists" do
-      let(:group) { KeycloakAdmin::GroupRepresentation.from_hash(
-        "id" => "test_group_id",
-        "name" => "test_group_name"
-      )}
-
-      before do
-        response = double
-        allow(response).to receive(:headers).and_return(
-          { location: 'http://auth.service.io/auth/admin/realms/valid-realm/groups/be061c48-6edd-4783-a726-1a57d4bfa22b' }
-        )
-
-        expect_any_instance_of(KeycloakAdmin::Resource).to receive(:put).with(group.to_json, anything).and_return response
-      end
-
-      it "saves a group" do
-        @group_client.save(group)
-      end
-
-      it "passes rest client options" do
-        faraday_options = {timeout: 10}
-        allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:faraday_options).and_return faraday_options
-
-        expect(KeycloakAdmin::Resource).to receive(:new).with(
-          "http://auth.service.io/auth/admin/realms/valid-realm/groups/test_group_id", faraday_options).and_call_original
-
-        @group_client.save(group)
-      end
-    end
-  end
-
-  describe "#create" do
-    let(:realm_name) { "valid-realm" }
-
-    before(:each) do
-      @group_client = KeycloakAdmin.realm(realm_name).groups
-
-      stub_token_client
-      @response = double(
-        headers: { location: 'http://auth.service.io/auth/admin/realms/valid-realm/groups/be061c48-6edd-4783-a726-1a57d4bfa22b' },
-        status: 201,
-        reason_phrase: 'Created'
-      )
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:post).and_return @response
-    end
-
-    it "creates a group" do
-      group_id = @group_client.create!("test_group_name")
-      expect(group_id).to eq 'be061c48-6edd-4783-a726-1a57d4bfa22b'
-    end
-
-    it "detects unexpected response to create a group" do
-      allow(@response).to receive(:status).and_return 200
-      allow(@response).to receive(:reason_phrase).and_return 'OK'
-
-      expect{ @group_client.create!("test_group_name") }.to raise_error(
-        'Create method returned status OK (Code: 200); expected status: Created (201)'
-      )
-    end
-  end
-
-  describe "#create_subgroup!" do
-    let(:realm_name) { "valid-realm" }
-
-    before(:each) do
-      @group_client = KeycloakAdmin.realm(realm_name).groups
-
-      stub_token_client
-      @response = double(
-        headers: { location: 'http://auth.service.io/auth/admin/realms/valid-realm/groups/7686af34-204c-4515-8122-78d19febbf6e' },
-        status: 201,
-        reason_phrase: 'Created'
-      )
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:post).and_return @response
-    end
-
-    it "creates a subgroup" do
-      group_id = @group_client.create_subgroup!('be061c48-6edd-4783-a726-1a57d4bfa22b', 'subgroup-name')
-      expect(group_id).to eq '7686af34-204c-4515-8122-78d19febbf6e'
-    end
-  end
-
-  describe "#delete" do
-    let(:realm_name) { "valid-realm" }
-
-    before(:each) do
-      @group_client = KeycloakAdmin.realm(realm_name).groups
-
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:delete).and_return ''
-    end
-
-    it "deletes a group" do
-      result = @group_client.delete("test_group_id")
-      expect(result).to be(true)
-    end
-
-    it "raises a delete error" do
-      faraday_options = {timeout: 10}
-      allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:faraday_options).and_return faraday_options
-
-      expect(KeycloakAdmin::Resource).to receive(:new).with(
-        "http://auth.service.io/auth/admin/realms/valid-realm/groups/test_group_id", faraday_options).and_raise("error")
-
-      expect { @group_client.delete("test_group_id") }.to raise_error("error")
-    end
-  end
-
-  describe '#get_realm_level_roles' do
-    let(:realm_name) { 'valid-realm' }
-    before(:each) do
-      @group_client = KeycloakAdmin.realm(realm_name).groups
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return '[{"id":"role-id","name":"role-name"}]'
-    end
-
-    it 'gets all realm-level roles for a group' do
-      roles = @group_client.get_realm_level_roles('test-group-id')
-      expect(roles.length).to eq 1
-      expect(roles[0].id).to eq 'role-id'
-      expect(roles[0].name).to eq 'role-name'
-    end
-  end
-
-  describe '#add_realm_level_role_name!' do
-    let(:realm_name) { 'valid-realm' }
-
-    before(:each) do
-      @group_client = KeycloakAdmin.realm(realm_name).groups
-
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:post).and_return ''
-    end
-
-    it 'adds a realm-level role to a group' do
-      role_representation = double
-      allow(role_representation).to receive(:name).and_return 'test-role-name'
-
-      role_client = double
-      allow(role_client).to receive(:get).with('test-role-name').and_return role_representation
-      allow(KeycloakAdmin::RoleClient).to receive(:new).and_return role_client
-
-      result = @group_client.add_realm_level_role_name!('test-group-id', 'test-role-name')
-      expect(result).to eq role_representation
-    end
-  end
-
-  describe '#remove_realm_level_role_name!' do
-    let(:realm_name) { 'valid-realm' }
-
-    before(:each) do
-      @group_client = KeycloakAdmin.realm(realm_name).groups
-
-      stub_token_client
-      allow(KeycloakAdmin::Resource).to receive(:execute).and_return ''
-    end
-
-    it 'deletes a realm-level role from a group' do
-      role_representation = double
-      allow(role_representation).to receive(:name).and_return 'test-role-name'
-
-      role_client = double
-      allow(role_client).to receive(:get).with('test-role-name').and_return role_representation
-      allow(KeycloakAdmin::RoleClient).to receive(:new).and_return role_client
-
-      result = @group_client.remove_realm_level_role_name!('test-group-id', 'test-role-name')
-      expect(result).to be(true)
-      expect(KeycloakAdmin::Resource).to have_received(:execute).with(
-        hash_including(
-          url: "http://auth.service.io/auth/admin/realms/valid-realm/groups/test-group-id/role-mappings/realm",
-          method: :delete,
-          payload: @group_client.send(:create_payload, [role_representation]),
-          headers: @group_client.send(:headers)
-        )
-      )
-    end
-  end
-end

data/spec/client/identity_provider_client_spec.rb

@@ -1,92 +0,0 @@
-RSpec.describe KeycloakAdmin::IdentityProviderClient do
-  describe "#identity_providers_url" do
-    let(:realm_name)  { "valid-realm" }
-    let(:provider_id) { nil }
-
-    before(:each) do
-      @built_url = KeycloakAdmin.realm(realm_name).identity_providers.identity_providers_url(provider_id)
-    end
-
-    context "when provider_id is not defined" do
-      let(:provider_id) { nil }
-      it "returns a proper url without provider id" do
-        expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/identity-provider/instances"
-      end
-    end
-
-    context "when provider_id is defined" do
-      let(:provider_id) { "95985b21-d884-4bbd-b852-cb8cd365afc2" }
-      it "returns a proper url with the provider id" do
-        expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/identity-provider/instances/95985b21-d884-4bbd-b852-cb8cd365afc2"
-      end
-    end
-  end
-
-  describe "#list" do
-    let(:realm_name) { "valid-realm" }
-    let(:json_response) do
-      <<-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
-    end
-    before(:each) do
-      @identity_provider_client = KeycloakAdmin.realm(realm_name).identity_providers
-
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return json_response
-    end
-
-    it "lists identity providers" do
-      identity_providers = @identity_provider_client.list
-      expect(identity_providers.length).to eq 1
-      expect(identity_providers[0].alias).to eq "acme"
-    end
-
-    it "passes rest client options" do
-      faraday_options = {timeout: 10}
-      allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:faraday_options).and_return faraday_options
-
-      expect(KeycloakAdmin::Resource).to receive(:new).with(
-        "http://auth.service.io/auth/admin/realms/valid-realm/identity-provider/instances", faraday_options).and_call_original
-
-      identity_providers = @identity_provider_client.list
-      expect(identity_providers.length).to eq 1
-      expect(identity_providers[0].alias).to eq "acme"
-    end
-  end
-end