keycloak-admin 2.0.1 → 2.0.2

data/spec/client/token_client_spec.rb

@@ -1,68 +0,0 @@
-RSpec.describe KeycloakAdmin::TokenClient do
-  describe "#initialize" do
-    let(:realm_name) { nil }
-    before(:each) do
-      @realm = KeycloakAdmin.realm(realm_name)
-    end
-
-    context "when realm_name is defined" do
-      let(:realm_name) { "master" }
-      it "does not raise any error" do
-        expect {
-          @realm.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 {
-          @realm.token
-        }.to raise_error(ArgumentError)
-      end
-    end
-  end
-
-  describe "#token_url" do
-    let(:realm_name) { "valid-realm" }
-    before(:each) do
-      @built_url = KeycloakAdmin.realm(realm_name).token.token_url
-    end
-
-    it "returns a proper url" do
-      expect(@built_url).to eq "http://auth.service.io/auth/realms/valid-realm/protocol/openid-connect/token"
-    end
-  end
-
-  describe "#get" do
-    let(:realm_name) { "valid-realm" }
-    before(:each) do
-      @token_client = KeycloakAdmin.realm(realm_name).token
-    end
-
-    it "parses the response" do
-      stub_post
-
-      token = @token_client.get
-      expect(token.access_token).to eq 'test_access_token'
-    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
-      stub_post
-
-      expect(KeycloakAdmin::Resource).to receive(:new).with(
-        "http://auth.service.io/auth/realms/valid-realm/protocol/openid-connect/token", faraday_options, anything).and_call_original
-
-      @token_client.get
-    end
-
-    def stub_post
-      response = double
-      allow(response).to receive(:body).and_return '{"access_token":"test_access_token"}'
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:post).and_return response
-    end
-  end
-end

data/spec/client/user_client_spec.rb

@@ -1,418 +0,0 @@
-RSpec.describe KeycloakAdmin::TokenClient do
-  describe "#initialize" do
-    let(:realm_name) { nil }
-    before(:each) do
-      @realm = KeycloakAdmin.realm(realm_name)
-    end
-
-    context "when realm_name is defined" do
-      let(:realm_name) { "master" }
-      it "does not raise any error" do
-        expect {
-          @realm.users
-        }.to_not raise_error
-      end
-    end
-
-    context "when realm_name is not defined" do
-      let(:realm_name) { nil }
-      it "raises any error" do
-        expect {
-          @realm.users
-        }.to raise_error(ArgumentError)
-      end
-    end
-  end
-
-  describe "#users_url" do
-    let(:realm_name) { "valid-realm" }
-    let(:user_id)    { nil }
-
-    before(:each) do
-      @built_url = KeycloakAdmin.realm(realm_name).users.users_url(user_id)
-    end
-
-    context "when user_id is not defined" do
-      let(:user_id) { nil }
-      it "return a proper url without user id" do
-        expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/users"
-      end
-    end
-
-    context "when user_id is defined" do
-      let(:user_id) { "95985b21-d884-4bbd-b852-cb8cd365afc2" }
-      it "return a proper url with the user id" do
-        expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/users/95985b21-d884-4bbd-b852-cb8cd365afc2"
-      end
-    end
-  end
-
-  describe "#reset_password_url" do
-    let(:realm_name) { "valid-realm" }
-    let(:user_id)    { nil }
-
-    before(:each) do
-      @client = KeycloakAdmin.realm(realm_name).users
-    end
-
-    context "when user_id is not defined" do
-      let(:user_id) { nil }
-      it "raises an error" do
-        expect {
-          @client.reset_password_url(user_id)
-        }.to raise_error(ArgumentError)
-      end
-    end
-
-    context "when user_id is defined" do
-      let(:user_id) { 42 }
-      it "return a proper url" do
-        expect(@client.reset_password_url(user_id)).to eq "http://auth.service.io/auth/admin/realms/valid-realm/users/42/reset-password"
-      end
-    end
-  end
-
-  describe "#execute_actions_email_url" do
-    let(:realm_name) { "valid-realm" }
-    let(:user_id)    { nil }
-
-    before(:each) do
-      @client = KeycloakAdmin.realm(realm_name).users
-    end
-
-    context "when user_id is not defined" do
-      let(:user_id) { nil }
-      it "raises an error" do
-        expect {
-          @client.execute_actions_email_url(user_id)
-        }.to raise_error(ArgumentError)
-      end
-    end
-
-    context "when user_id is defined" do
-      let(:user_id) { 42 }
-      it "return a proper url" do
-        expect(@client.execute_actions_email_url(user_id)).to eq "http://auth.service.io/auth/admin/realms/valid-realm/users/42/execute-actions-email"
-      end
-    end
-  end
-
-  describe "#impersonation_url" do
-    let(:realm_name) { "valid-realm" }
-    let(:user_id)    { nil }
-
-    before(:each) do
-      @client = KeycloakAdmin.realm(realm_name).users
-    end
-
-    context "when user_id is not defined" do
-      let(:user_id) { nil }
-      it "raises an error" do
-        expect {
-          @client.impersonation_url(user_id)
-        }.to raise_error(ArgumentError)
-      end
-    end
-
-    context "when user_id is defined" do
-      let(:user_id) { 42 }
-      it "return a proper url" do
-        expect(@client.impersonation_url(user_id)).to eq "http://auth.service.io/auth/admin/realms/valid-realm/users/42/impersonation"
-      end
-    end
-  end
-
-  describe "#save" do
-    let(:realm_name) { "valid-realm" }
-    let(:user) { KeycloakAdmin::UserRepresentation.from_hash(
-      "username" => "test_username",
-      "createdTimestamp" => Time.now.to_i,
-    )}
-
-    before(:each) do
-      @user_client = KeycloakAdmin.realm(realm_name).users
-
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:post)
-    end
-
-    it "saves a user" do
-      expect(@user_client.save(user)).to eq user
-    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/users", faraday_options, anything).and_call_original
-
-      expect(@user_client.save(user)).to eq user
-    end
-  end
-
-  describe "#get" do
-    let(:realm_name) { "valid-realm" }
-
-    before(:each) do
-      @user_client = KeycloakAdmin.realm(realm_name).users
-
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return '{"username":"test_username","createdTimestamp":1559347200, "requiredActions":["CONFIGURE_TOTP"], "totp": true}'
-    end
-
-    it "parses the response" do
-      user = @user_client.get('test_user_id')
-      expect(user.username).to eq 'test_username'
-    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/users/test_user_id", faraday_options, anything).and_call_original
-
-      user = @user_client.get('test_user_id')
-      expect(user.username).to eq 'test_username'
-      expect(user.totp).to be true
-      expect(user.required_actions).to eq ["CONFIGURE_TOTP"]
-    end
-  end
-
-  describe "#search" do
-    let(:realm_name) { "valid-realm" }
-    let(:user) { KeycloakAdmin::UserRepresentation.from_hash(
-      "username" => "test_username",
-      "createdTimestamp" => Time.now.to_i,
-    )}
-
-    before(:each) do
-      @user_client = KeycloakAdmin.realm(realm_name).users
-
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return '[{"username":"test_username","createdTimestamp":1559347200}]'
-    end
-
-    it "finds a user using a string" do
-      users = @user_client.search("test_username")
-      expect(users.length).to eq 1
-      expect(users[0].username).to eq "test_username"
-    end
-
-    it "finds a user using nil does not fail" do
-      users = @user_client.search(nil)
-      expect(users.length).to eq 1
-      expect(users[0].username).to eq "test_username"
-    end
-
-    it "finds a user using a hash" do
-      users = @user_client.search({ search: "test_username"})
-      expect(users.length).to eq 1
-      expect(users[0].username).to eq "test_username"
-    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/users", faraday_options, anything).and_call_original
-
-      users = @user_client.search("test_username")
-      expect(users.length).to eq 1
-      expect(users[0].username).to eq "test_username"
-    end
-  end
-
-  describe "#list" do
-    let(:realm_name) { "valid-realm" }
-    let(:user) { KeycloakAdmin::UserRepresentation.from_hash(
-      "username" => "test_username",
-      "createdTimestamp" => Time.now.to_i,
-    )}
-
-    before(:each) do
-      @user_client = KeycloakAdmin.realm(realm_name).users
-
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return '[{"username":"test_username","createdTimestamp":1559347200}]'
-    end
-
-    it "lists users" do
-      users = @user_client.list
-      expect(users.length).to eq 1
-      expect(users[0].username).to eq "test_username"
-    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/users", faraday_options, anything).and_call_original
-
-      users = @user_client.list
-      expect(users.length).to eq 1
-      expect(users[0].username).to eq "test_username"
-    end
-  end
-
-  describe "#delete" do
-    let(:realm_name) { "valid-realm" }
-
-    before(:each) do
-      @user_client = KeycloakAdmin.realm(realm_name).users
-
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:delete)
-    end
-
-    it "does not fail" do
-      expect(@user_client.delete('test_user_id')).to be_truthy
-    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/users/test_user_id", faraday_options, anything).and_call_original
-
-      @user_client.delete('test_user_id')
-    end
-  end
-
-  describe '#update' do
-    let(:realm_name) { 'valid-realm' }
-    before(:each) do
-      @user_client = KeycloakAdmin.realm(realm_name).users
-
-      stub_token_client
-      allow(KeycloakAdmin::Resource).to receive(:execute).and_return "write a better test"
-    end
-
-    context 'when user_id is defined' do
-      let(:user_id) { '95985b21-d884-4bbd-b852-cb8cd365afc2' }
-
-      it 'updates the user details' do
-        ## TODO use this expected payload to check whether it has been sent or not
-        expected_payload = {
-          method:  :put,
-          url:     "http://auth.service.io/auth/admin/realms/valid-realm/users/95985b21-d884-4bbd-b852-cb8cd365afc2",
-          payload: '{"firstName":"Test","enabled":false}',
-          headers: {
-            Authorization: "Bearer test_access_token",
-            content_type: :json,
-            accept: :json
-          }
-        }
-        response = @user_client.update(user_id, { firstName: 'Test', enabled: false })
-        expect(response).to eq "write a better test"
-      end
-    end
-
-    context 'when user_id is not defined' do
-      let(:user_id) { '95985b21-d884-4bbd-b852-cb8cd365afc2' }
-
-      let(:user_id) { nil }
-      it 'raise argument error' do
-        expect { @user_client.update(user_id, { firstName: 'Test', enabled: false }) }.to raise_error(ArgumentError)
-      end
-    end
-  end
-
-  describe '#sessions' do
-    let(:realm_name) { "valid-realm" }
-
-    before(:each) do
-      @user_client = KeycloakAdmin.realm(realm_name).users
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return '[{"id":"95985b21-d884-4bbd-b852-dsfsdfsd","username":"test_username", "ip_address":"0.0.0.0"}]'
-    end
-
-    context 'when user_id is defined' do
-      let(:user_id) { '95985b21-d884-4bbd-b852-cb8cd365afc2' }
-      it 'returns list of active sessions' do
-        response = @user_client.sessions(user_id)
-        expect(response[0].id).to eq '95985b21-d884-4bbd-b852-dsfsdfsd'
-      end
-    end
-
-    context 'when user_id is not defined' do
-      let(:user_id) { nil }
-      it 'raise argument error' do
-        expect { @user_client.sessions(user_id) }.to raise_error(ArgumentError)
-      end
-    end
-  end
-
-  describe '#logout' do
-    let(:realm_name) { 'valid-realm' }
-
-    before(:each) do
-      @user_client = KeycloakAdmin.realm(realm_name).users
-      stub_token_client
-      allow(KeycloakAdmin::Resource).to receive(:execute)
-    end
-
-    context 'when user_id is defined' do
-      let(:user_id) { '95985b21-d884-4bbd-b852-cb8cd365afc2' }
-      it 'logout user and return true' do
-        expect(@user_client.logout(user_id)).to be_truthy
-      end
-    end
-
-    context 'when user_id is not defined' do
-      let(:user_id) { nil }
-      it 'raise argument error' do
-        expect { @user_client.logout(user_id) }.to raise_error(ArgumentError)
-      end
-    end
-  end
-
-  describe '#credentials' do
-    let(:realm_name) { "valid-realm" }
-
-    before(:each) do
-      @user_client = KeycloakAdmin.realm(realm_name).users
-      stub_token_client
-      json_payload = <<-'payload'
-        [
-          {
-            "id": "2ff4b4d0-fd72-4c6e-9684-02ab337687c2",
-            "type": "password",
-            "userLabel": "My password",
-            "createdDate": 1767604673211,
-            "credentialData": "{\"hashIterations\":5,\"algorithm\":\"argon2\",\"additionalParameters\":{\"hashLength\":[\"32\"],\"memory\":[\"7168\"],\"type\":[\"id\"],\"version\":[\"1.3\"],\"parallelism\":[\"1\"]}}"
-          },
-          {
-            "id": "34389672-9356-4154-9ed6-6c212b869010",
-            "type": "otp",
-            "userLabel": "Smartphone",
-            "createdDate": 1767605202060,
-            "credentialData": "{\"subType\":\"totp\",\"digits\":6,\"counter\":0,\"period\":30,\"algorithm\":\"HmacSHA1\"}"
-          }
-        ]
-      payload
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return json_payload
-    end
-
-    context 'when user_id is defined' do
-      let(:user_id) { '95985b21-d884-4bbd-b852-cb8cd365afc2' }
-      it 'returns list of credentials' do
-        response = @user_client.credentials(user_id)
-        expect(response.size).to eq 2
-        expect(response[0].id).to eq "2ff4b4d0-fd72-4c6e-9684-02ab337687c2"
-        expect(response[1].id).to eq "34389672-9356-4154-9ed6-6c212b869010"
-      end
-    end
-
-    context 'when user_id is not defined' do
-      let(:user_id) { nil }
-      it 'raise argument error' do
-        expect { @user_client.credentials(user_id) }.to raise_error(ArgumentError)
-      end
-    end
-  end
-end

data/spec/configuration_spec.rb

@@ -1,150 +0,0 @@
-RSpec.describe KeycloakAdmin::RealmClient do
-
-  let(:client_id)           { "admin-cli" }
-  let(:client_secret)       { "aaaaaaaa" }
-  let(:client_realm_name)   { "master2" }
-  let(:use_service_account) { true }
-  let(:username)            { "a" }
-  let(:password)            { "b" }
-  let(:faraday_options) { {timeout: 10 } }
-
-  before(:each) do
-    @configuration                     = KeycloakAdmin::Configuration.new
-    @configuration.server_url          = "http://auth.service.io/auth"
-    @configuration.server_domain       = "auth.service.io"
-    @configuration.client_id           = client_id
-    @configuration.client_secret       = client_secret
-    @configuration.client_realm_name   = client_realm_name
-    @configuration.use_service_account = use_service_account
-    @configuration.username            = username
-    @configuration.password            = password
-    @configuration.faraday_options = faraday_options
-  end
-
-  describe "#headers_for_token_retrieval" do
-    before(:each) do
-      @headers = @configuration.headers_for_token_retrieval
-    end
-    
-    context "when use_service_account is false" do
-      let(:use_service_account) { false }
-      it "returns an empty hash" do 
-        expect(@headers).to be_empty
-      end
-    end
-
-    context "when use_service_account is true" do
-      let(:use_service_account) { true }
-      it "returns a single element" do
-        expect(@headers.size).to eq 1
-      end
-
-      it "returns the Authorization Key" do
-        expect(@headers.has_key?(:Authorization)).to be true
-      end
-
-      it "returns a Basic Authorization Key" do
-        expect(@headers[:Authorization]).to start_with "Basic"
-      end
-
-      context "client_id='a' and client_secret='b'" do
-        let(:client_id)           { "a" }
-        let(:client_secret)       { "b" }
-
-        it "returns a Basic Authorization = 'Basic YTpi'" do
-          expect(@headers[:Authorization]).to eq "Basic YTpi"
-        end
-      end
-
-      context "client_id='365e3c66-fd0f-11e7-8be5-0ed5f89f718b' and client_secret='411e6f9a-fd0f-11e7-8be5-0ed5f89f718b'" do
-        let(:client_id)           { "365e3c66-fd0f-11e7-8be5-0ed5f89f718b" }
-        let(:client_secret)       { "411e6f9a-fd0f-11e7-8be5-0ed5f89f718b" }
-
-        it "returns a Basic Authorization = 'Basic MzY1ZTNjNjYtZmQwZi0xMWU3LThiZTUtMGVkNWY4OWY3MThiOjQxMWU2ZjlhLWZkMGYtMTFlNy04YmU1LTBlZDVmODlmNzE4Yg=='" do
-          expect(@headers[:Authorization]).to eq "Basic MzY1ZTNjNjYtZmQwZi0xMWU3LThiZTUtMGVkNWY4OWY3MThiOjQxMWU2ZjlhLWZkMGYtMTFlNy04YmU1LTBlZDVmODlmNzE4Yg=="
-        end
-      end
-
-    end
-  end
-
-  describe "#cached_token / #cache_token / #clear_cached_token!" do
-    def token(expires_in)
-      KeycloakAdmin::TokenRepresentation.new(
-        "access_token", "bearer", expires_in, "refresh_token",
-        "refresh_expires_in", "id_token", "not_before_policy", "session_state"
-      )
-    end
-
-    it "has no cached token initially" do
-      expect(@configuration.cached_token).to be_nil
-    end
-
-    it "returns the token it was given, while it is still within its expiry" do
-      cached = @configuration.cache_token(token(3600))
-      expect(cached.access_token).to eq "access_token"
-      expect(@configuration.cached_token).to eq cached
-    end
-
-    it "treats a token as expired a bit before its real expiry, not just after" do
-      # expires_in: 5, minus the 10s safety margin, is already in the past the moment it is cached.
-      @configuration.cache_token(token(5))
-      expect(@configuration.cached_token).to be_nil
-    end
-
-    it "does not cache a token with a non-numeric expires_in, but still returns it" do
-      returned = @configuration.cache_token(token("not-a-number"))
-      expect(returned.access_token).to eq "access_token"
-      expect(@configuration.cached_token).to be_nil
-    end
-
-    it "clears the cache" do
-      @configuration.cache_token(token(3600))
-      @configuration.clear_cached_token!
-      expect(@configuration.cached_token).to be_nil
-    end
-  end
-
-  describe "#body_for_token_retrieval" do
-    before(:each) do
-      @body = @configuration.body_for_token_retrieval
-    end
-    context "when use_service_account is false" do
-      let(:use_service_account) { false }
-      it "returns a hash of 5 elements" do
-        expect(@body.size).to eq 5
-      end
-
-      it "returns a hash containing the username" do
-        expect(@body[:username]).to eq username
-      end
-
-      it "returns a hash containing the password" do
-        expect(@body[:password]).to eq password
-      end
-
-      it "returns a hash containing the grant_type 'password'" do
-        expect(@body[:grant_type]).to eq "password"
-      end
-
-      it "returns a hash containing the client_id" do
-        expect(@body[:client_id]).to eq client_id
-      end
-
-      it "returns a hash containing the client_secret" do
-        expect(@body[:client_secret]).to eq client_secret
-      end
-    end
-
-    context "when use_service_account is true" do
-      let(:use_service_account) { true }
-      it "returns a hash of 1 element" do
-        expect(@body.size).to eq 1
-      end
-
-      it "returns a hash containing the grant_type" do
-        expect(@body[:grant_type]).to eq "client_credentials"
-      end
-    end
-  end
-end

data/spec/gemspec_spec.rb

@@ -1,25 +0,0 @@
-RSpec.describe "keycloak-admin.gemspec" do
-  let(:gemspec_path) { File.expand_path("../keycloak-admin.gemspec", __dir__) }
-  let(:gemspec)      { Gem::Specification.load(gemspec_path) }
-
-  it "loads" do
-    expect(gemspec).to be_a(Gem::Specification)
-    expect(gemspec.name).to eq "keycloak-admin"
-  end
-
-  it "declares Ruby 3.1 as the minimum supported version" do
-    expect(gemspec.required_ruby_version.to_s).to eq ">= 3.1"
-  end
-
-  # The CI matrix runs the oldest supported Ruby. If `required_ruby_version` is
-  # ever raised without widening that matrix, or the matrix drops below what the
-  # gemspec promises, this fails on the offending job instead of silently
-  # shipping a gem that cannot install.
-  it "is installable on the Ruby running this suite" do
-    running_ruby = Gem::Version.new(RUBY_VERSION)
-
-    expect(gemspec.required_ruby_version.satisfied_by?(running_ruby)).to be(true),
-      "gemspec requires Ruby #{gemspec.required_ruby_version}, " \
-      "but the suite is running on #{RUBY_VERSION}"
-  end
-end