keycloak-admin 2.0.1 → 2.0.3

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/Dockerfile

@@ -1,13 +0,0 @@
-FROM ruby:3.3.12-slim-trixie
-
-RUN apt-get update -qq && apt-get install -y build-essential git ruby-dev && apt-get clean && \
-  mkdir -p /usr/src/app/lib/keycloak-admin
-WORKDIR /usr/src/app
-
-COPY Gemfile /usr/src/app/
-COPY Gemfile.lock /usr/src/app/
-COPY keycloak-admin.gemspec /usr/src/app/
-COPY lib/keycloak-admin/version.rb /usr/src/app/lib/keycloak-admin/
-RUN bundle install
-COPY . /usr/src/app
-RUN bundle install

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec

data/Gemfile.lock

@@ -1,54 +0,0 @@
-PATH
-  remote: .
-  specs:
-    keycloak-admin (2.0.1)
-      base64
-      faraday (~> 2.0)
-      http-cookie (~> 1.0, >= 1.0.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    base64 (0.3.0)
-    byebug (12.0.0)
-    diff-lcs (1.6.2)
-    domain_name (0.6.20240107)
-    faraday (2.14.3)
-      faraday-net_http (>= 2.0, < 3.5)
-      json
-      logger
-    faraday-net_http (3.4.4)
-      net-http (~> 0.5)
-    http-cookie (1.1.6)
-      domain_name (~> 0.5)
-    json (2.21.2)
-    logger (1.7.0)
-    net-http (0.9.1)
-      uri (>= 0.11.1)
-    rake (13.4.2)
-    rspec (3.13.2)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.6)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.8)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.7)
-    uri (1.1.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  byebug (= 12.0.0)
-  keycloak-admin!
-  rake (>= 13.0)
-  rspec (= 3.13.2)
-
-BUNDLED WITH
-   2.6.9

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/bin/console

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "keycloak-admin"
-require "byebug"
-
-require "irb"
-IRB.start

data/spec/client/attack_detection_client_spec.rb

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe KeycloakAdmin::AttackDetectionClient 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.attack_detections }.to_not raise_error
-      end
-    end
-
-    context "when realm_name is not defined" do
-      it "raise argument error" do
-        expect { @realm.attack_detections }.to raise_error(ArgumentError)
-      end
-    end
-  end
-
-  describe "#lock_status" do
-    let(:realm_name) { "valid-realm" }
-    before(:each) do
-      @attack_detections = KeycloakAdmin.realm(realm_name).attack_detections
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return '{"numFailures":1,"disabled":true, "lastFailure":123456}'
-    end
-
-    context "when user_id is defined" do
-      let(:user_id) { "test_user_id" }
-      it "returns lock details" do
-        response = @attack_detections.lock_status(user_id)
-        expect(response.num_failures).to eq 1
-      end
-    end
-
-    context "when user_id is not defined" do
-      let(:user_id) { nil }
-      it "raise argument error" do
-        expect { @attack_detections.lock_status(user_id) }.to raise_error(ArgumentError)
-      end
-    end
-  end
-
-  describe "#unlock_user" do
-    let(:realm_name) { "valid-realm" }
-    before(:each) do
-      @attack_detections = KeycloakAdmin.realm(realm_name).attack_detections
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:delete)
-    end
-
-    context "when user_id is defined" do
-      let(:user_id) { "test_user_id" }
-      it "returns true" do
-        expect(@attack_detections.unlock_user(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 { @attack_detections.unlock_user(user_id) }.to raise_error(ArgumentError)
-      end
-    end
-  end
-
-  describe "#unlock_users" do
-    let(:realm_name) { "valid-realm" }
-    before(:each) do
-      @attack_detections = KeycloakAdmin.realm(realm_name).attack_detections
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:delete)
-    end
-    it "returns true" do
-      expect(@attack_detections.unlock_users).to be_truthy
-    end
-  end
-
-  describe "#brute_force_url" do
-    let(:realm_name) { "valid-realm" }
-    let(:user_id)    { nil }
-    before(:each) do
-      @attack_detections_url = KeycloakAdmin.realm(realm_name).attack_detections.brute_force_url(user_id)
-    end
-
-    context "when user_id is defined" do
-      let(:user_id)    { "95985b21-d884-4bbd-b852-cb8cd365afc2" }
-      it "returns user specific url" do
-        expect(@attack_detections_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/attack-detection/brute-force/users/#{user_id}"
-      end
-    end
-
-    context "when user_id is not defined" do
-      it "returns url without user" do
-        expect(@attack_detections_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/attack-detection/brute-force/users"
-      end
-    end
-  end
-end

data/spec/client/client_authz_permission_client_spec.rb

@@ -1,170 +0,0 @@
-RSpec.describe KeycloakAdmin::ClientAuthzPermissionClient do
-
-  describe "#initialize" do
-    let(:realm_name) { nil }
-    let(:type) { :scope }
-    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.authz_permissions("", type)
-        }.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.authz_permissions("", type)
-        }.to raise_error(ArgumentError)
-      end
-    end
-
-    context "when type is bad value" do
-      let(:realm_name) { "master" }
-      let(:type) { "bad-type" }
-      it "does not raise any error" do
-        expect {
-          @realm.authz_permissions("", type)
-        }.to raise_error(ArgumentError)
-      end
-    end
-  end
-
-  describe '#delete' do
-    let(:realm_name) { "valid-realm" }
-    let(:client_id) { "valid-client-id" }
-    let(:client_authz_permission) {  KeycloakAdmin.realm(realm_name).authz_permissions(client_id, "resource") }
-    before(:each) do
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:delete).and_return 'true'
-    end
-
-    it "deletes a permission" do
-      expect(client_authz_permission.delete("valid-permission-id")).to be_truthy
-    end
-  end
-
-  describe '#find_by' do
-    let(:realm_name) { "valid-realm" }
-    let(:client_id) { "valid-client-id" }
-    let(:client_authz_permission) {  KeycloakAdmin.realm(realm_name).authz_permissions(client_id, "resource") }
-    before(:each) do
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return '[{"id":"245ce612-ccdc-4426-8ea7-e0e29a718033","name":"Default Permission","description":"A permission that applies to the default resource type","type":"resource","logic":"POSITIVE","decisionStrategy":"UNANIMOUS","resourceType":"urn:dummy-client:resources:default"},{"id":"06a21e38-4e92-466d-8647-ffcd9c7b51c3","name":"delme policy","description":"delme polidy ","type":"resource","logic":"POSITIVE","decisionStrategy":"UNANIMOUS","resourceType":"asdfasdf"}]'
-    end
-
-    it "finds permissions" do
-      response = client_authz_permission.find_by("name", "resource", "scope")
-      expect(response[0].id).to eql "245ce612-ccdc-4426-8ea7-e0e29a718033"
-      expect(response[1].id).to eql "06a21e38-4e92-466d-8647-ffcd9c7b51c3"
-    end
-  end
-
-  describe '#create!' do
-    let(:realm_name) { "valid-realm" }
-    let(:client_id) { "valid-client-id" }
-    let(:client_authz_permission) {  KeycloakAdmin.realm(realm_name).authz_permissions(client_id, "resource") }
-    before(:each) do
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:post).and_return '{"id":"245ce612-ccdc-4426-8ea7-e0e29a718033","name":"Default Permission","description":"A permission that applies to the default resource type","type":"resource","logic":"POSITIVE","decisionStrategy":"UNANIMOUS","resourceType":"urn:dummy-client:resources:default"}'
-    end
-
-    it "creates a permission" do
-      response = client_authz_permission.create!("name", "description", "UNANIMOUS", "POSITIVE", [], [], [], "resource")
-      expect(response.id).to eql "245ce612-ccdc-4426-8ea7-e0e29a718033"
-      expect(response.name).to eql "Default Permission"
-      expect(response.description).to eql "A permission that applies to the default resource type"
-      expect(response.logic).to eql "POSITIVE"
-      expect(response.decision_strategy).to eql "UNANIMOUS"
-      expect(response.resource_type).to eql "urn:dummy-client:resources:default"
-    end
-  end
-
-  describe '#list' do
-    let(:realm_name) { "valid-realm" }
-    let(:client_id) { "valid-client-id" }
-    before(:each) do
-      @client_authz_permission = KeycloakAdmin.realm(realm_name).authz_permissions(client_id, "resource")
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return '[{"id":"245ce612-ccdc-4426-8ea7-e0e29a718033","name":"Default Permission","description":"A permission that applies to the default resource type","type":"resource","logic":"POSITIVE","decisionStrategy":"UNANIMOUS","resourceType":"urn:dummy-client:resources:default"},{"id":"06a21e38-4e92-466d-8647-ffcd9c7b51c3","name":"delme policy","description":"delme polidy ","type":"resource","logic":"POSITIVE","decisionStrategy":"UNANIMOUS","resourceType":"asdfasdf"}]'
-
-    end
-
-    it "returns list of authz permissions" do
-      response = @client_authz_permission.list
-      expect(response.size).to eq 2
-      expect(response[0].id).to eq "245ce612-ccdc-4426-8ea7-e0e29a718033"
-      expect(response[0].name).to eq "Default Permission"
-      expect(response[0].description).to eq "A permission that applies to the default resource type"
-      expect(response[0].logic).to eq "POSITIVE"
-      expect(response[0].decision_strategy).to eq "UNANIMOUS"
-      expect(response[0].resource_type).to eq "urn:dummy-client:resources:default"
-    end
-  end
-
-  describe '#get' do
-    let(:realm_name) { "valid-realm" }
-    let(:client_id) { "valid-client-id" }
-    let(:client_authz_permission) {  KeycloakAdmin.realm(realm_name).authz_permissions(client_id, "resource") }
-    before(:each) do
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return '{"id":"245ce612-ccdc-4426-8ea7-e0e29a718033","name":"Default Permission","description":"A permission that applies to the default resource type","type":"resource","logic":"POSITIVE","decisionStrategy":"UNANIMOUS","resourceType":"urn:dummy-client:resources:default"}'
-    end
-
-    it "gets a permission" do
-      response = client_authz_permission.get("245ce612-ccdc-4426-8ea7-e0e29a718033")
-      expect(response.id).to eql "245ce612-ccdc-4426-8ea7-e0e29a718033"
-      expect(response.name).to eql "Default Permission"
-      expect(response.description).to eql "A permission that applies to the default resource type"
-      expect(response.logic).to eql "POSITIVE"
-      expect(response.decision_strategy).to eql "UNANIMOUS"
-      expect(response.resource_type).to eql "urn:dummy-client:resources:default"
-    end
-  end
-
-  describe '#authz_permission_url' do
-    let(:realm_name) { "valid-realm" }
-    let(:client_id) { "valid-client-id" }
-    let(:resource_id){ "valid-resource-id" }
-    let(:type){ "resource" }
-    let(:client_authz_permission) { KeycloakAdmin.realm(realm_name).authz_permissions(client_id, type, resource_id) }
-    context 'when resource_id is nil' do
-      it "return a proper url" do
-        expect(client_authz_permission.authz_permission_url(client_id)).to eq "http://auth.service.io/auth/admin/realms/valid-realm/clients/valid-client-id/authz/resource-server/permission/"
-      end
-    end
-    context 'when resource_id is not nil' do
-      it "return a proper url" do
-        expect(client_authz_permission.authz_permission_url(client_id, resource_id)).to eq "http://auth.service.io/auth/admin/realms/valid-realm/clients/valid-client-id/authz/resource-server/resource/valid-resource-id/permissions"
-      end
-    end
-    context 'when id is not nil' do
-      it "return a proper url" do
-        expect(client_authz_permission.authz_permission_url(client_id, nil, :resource, "valid-permission-id")).to eq "http://auth.service.io/auth/admin/realms/valid-realm/clients/valid-client-id/authz/resource-server/permission/resource/valid-permission-id"
-      end
-    end
-    context 'when resource_id and id are nil' do
-      it "return a proper url" do
-        expect(client_authz_permission.authz_permission_url(client_id, nil, :resource)).to eq "http://auth.service.io/auth/admin/realms/valid-realm/clients/valid-client-id/authz/resource-server/permission/resource"
-      end
-    end
-  end
-
-  describe '#authz_permission_url' do
-    let(:realm_name) { "valid-realm" }
-    let(:client_id) { "valid-client-id" }
-    before(:each) do
-      @client_authz_permission = KeycloakAdmin.realm(realm_name).authz_permissions(client_id, "resource")
-    end
-
-    it "return a proper url" do
-      expect(@client_authz_permission.authz_permission_url(client_id)).to eq "http://auth.service.io/auth/admin/realms/valid-realm/clients/valid-client-id/authz/resource-server/permission/"
-    end
-  end
-end

data/spec/client/client_authz_policy_client_spec.rb

@@ -1,170 +0,0 @@
-RSpec.describe KeycloakAdmin::ClientAuthzPolicyClient do
-
-  describe '#initialize' do
-    let(:realm_name) { nil }
-    let(:type) { :role }
-    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.authz_policies("", type)
-        }.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.authz_policies("", type)
-        }.to raise_error(ArgumentError)
-      end
-    end
-
-    context "when type is bad value" do
-      let(:realm_name) { "master" }
-      let(:type) { "bad-type" }
-      it "does not raise any error" do
-        expect {
-          @realm.authz_policies("", type)
-        }.to raise_error(ArgumentError)
-      end
-    end
-  end
-
-  describe '#create!' do
-    let(:realm_name) { "valid-realm" }
-    let(:client_id) { "valid-client-id" }
-    let(:type) { :role }
-    let(:name) { "policy name" }
-    let(:description) { "policy description" }
-    let(:logic) { "POSITIVE" }
-    let(:decision_strategy) { "UNANIMOUS" }
-    let(:fetch_roles) { true }
-    let(:config) { { roles: [{ id: "1d305dbe-6379-4900-8e63-96541006160a", required: false }] } }
-    let(:client_authz_policy){ KeycloakAdmin.realm(realm_name).authz_policies(client_id, type) }
-
-    before(:each) do
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:post).and_return '{"id":"234f6f33-ef03-4f3f-a8c0-ad7bca27b720","name":"policy name","description":"policy description","type":"role","logic":"POSITIVE","decisionStrategy":"UNANIMOUS","config":{"roles":"[{\"id\":\"1d305dbe-6379-4900-8e63-96541006160a\",\"required\":false}]"}}'
-    end
-
-    it "creates a new authz policy" do
-      response = client_authz_policy.create!(name, description, type, logic, decision_strategy, fetch_roles, config[:roles])
-      expect(response.id).to eq "234f6f33-ef03-4f3f-a8c0-ad7bca27b720"
-      expect(response.name).to eq "policy name"
-      expect(response.type).to eq "role"
-      expect(response.logic).to eq "POSITIVE"
-      expect(response.decision_strategy).to eq "UNANIMOUS"
-      expect(response.config.roles[0].id).to eq "1d305dbe-6379-4900-8e63-96541006160a"
-    end
-  end
-
-  describe '#get' do
-    let(:realm_name) { "valid-realm" }
-    let(:client_id) { "valid-client-id" }
-    let(:type) { :role }
-    let(:policy_id) { "234f6f33-ef03-4f3f-a8c0-ad7bca27b720" }
-    let(:client_authz_policy){ KeycloakAdmin.realm(realm_name).authz_policies(client_id, type) }
-    before(:each) do
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return '{"id":"234f6f33-ef03-4f3f-a8c0-ad7bca27b720","name":"policy name","description":"policy description","type":"role","logic":"POSITIVE","decisionStrategy":"UNANIMOUS","config":{"roles":"[{\"id\":\"1d305dbe-6379-4900-8e63-96541006160a\",\"required\":false}]"}}'
-    end
-
-    it "returns an authz policy" do
-      response = client_authz_policy.get(policy_id)
-      expect(response.id).to eq "234f6f33-ef03-4f3f-a8c0-ad7bca27b720"
-      expect(response.name).to eq "policy name"
-      expect(response.type).to eq "role"
-      expect(response.logic).to eq "POSITIVE"
-      expect(response.decision_strategy).to eq "UNANIMOUS"
-      expect(response.config.roles[0].id).to eq "1d305dbe-6379-4900-8e63-96541006160a"
-    end
-  end
-
-  describe '#find_by' do
-    let(:realm_name) { "valid-realm" }
-    let(:client_id) { "valid-client-id" }
-    let(:type) { :role }
-    let(:name) { "policy name" }
-    let(:client_authz_policy){ KeycloakAdmin.realm(realm_name).authz_policies(client_id, type) }
-    before(:each) do
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return '[{"id":"234f6f33-ef03-4f3f-a8c0-ad7bca27b720","name":"policy name","description":"policy description","type":"role","logic":"POSITIVE","decisionStrategy":"UNANIMOUS","config":{"roles":"[{\"id\":\"1d305dbe-6379-4900-8e63-96541006160a\",\"required\":false}]"}}]'
-    end
-
-    it "returns list of authz policies" do
-      response = client_authz_policy.find_by(name, type)
-      expect(response.size).to eq 1
-      expect(response[0].id).to eq "234f6f33-ef03-4f3f-a8c0-ad7bca27b720"
-      expect(response[0].name).to eq "policy name"
-      expect(response[0].type).to eq "role"
-      expect(response[0].logic).to eq "POSITIVE"
-      expect(response[0].decision_strategy).to eq "UNANIMOUS"
-      expect(response[0].config.roles[0].id).to eq "1d305dbe-6379-4900-8e63-96541006160a"
-    end
-  end
-
-  describe '#delete' do
-    let(:realm_name) { "valid-realm" }
-    let(:client_id) { "valid-client-id" }
-    let(:type) { :role }
-    let(:policy_id) { "234f6f33-ef03-4f3f-a8c0-ad7bca27b720" }
-    before(:each) do
-      @client_authz_policy = KeycloakAdmin.realm(realm_name).authz_policies(client_id, type)
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:delete).and_return 'true'
-    end
-
-    it "deletes an authz policy" do
-      response = @client_authz_policy.delete(policy_id)
-      expect(response).to eq true
-    end
-  end
-
-  describe '#list' do
-    let(:realm_name) { "valid-realm" }
-    let(:client_id) { "valid-client-id" }
-    let(:type) { :role }
-    before(:each) do
-      @client_authz_policy = KeycloakAdmin.realm(realm_name).authz_policies(client_id, type)
-      stub_token_client
-      allow_any_instance_of(KeycloakAdmin::Resource).to receive(:get).and_return '[{"id":"234f6f33-ef03-4f3f-a8c0-ad7bca27b720","name":"policy name","description":"policy description","type":"role","logic":"POSITIVE","decisionStrategy":"UNANIMOUS","config":{"roles":"[{\"id\":\"1d305dbe-6379-4900-8e63-96541006160a\",\"required\":false}]"}}]'
-    end
-
-    it "returns list of authz policies" do
-      response = @client_authz_policy.list
-      expect(response.size).to eq 1
-      expect(response[0].id).to eq "234f6f33-ef03-4f3f-a8c0-ad7bca27b720"
-      expect(response[0].name).to eq "policy name"
-      expect(response[0].type).to eq "role"
-      expect(response[0].logic).to eq "POSITIVE"
-      expect(response[0].decision_strategy).to eq "UNANIMOUS"
-      expect(response[0].config.roles[0].id).to eq "1d305dbe-6379-4900-8e63-96541006160a"
-    end
-  end
-
-  describe '#authz_policy_url' do
-    let(:realm_name) { "valid-realm" }
-    let(:client_id) { "valid-client-id" }
-    let(:type) { :role }
-    let(:client_authz_policy){ KeycloakAdmin.realm(realm_name).authz_policies(client_id, type) }
-
-    context 'when policy_id is nil' do
-      let(:policy_id) { nil }
-      it "return a proper url" do
-        expect(client_authz_policy.authz_policy_url(client_id, type, policy_id)).to eq "http://auth.service.io/auth/admin/realms/valid-realm/clients/valid-client-id/authz/resource-server/policy/role?permission=false"
-      end
-    end
-    context 'when policy_id is not nil' do
-      let(:policy_id) { "234f6f33-ef03-4f3f-a8c0-ad7bca27b720" }
-      it "return a proper url" do
-        expect(client_authz_policy.authz_policy_url(client_id, type, policy_id)).to eq "http://auth.service.io/auth/admin/realms/valid-realm/clients/valid-client-id/authz/resource-server/policy/role/234f6f33-ef03-4f3f-a8c0-ad7bca27b720"
-      end
-    end
-  end
-end