keycloak-admin 2.0.0 → 2.0.2

data/lib/keycloak-admin/error.rb

@@ -0,0 +1,62 @@
+module KeycloakAdmin
+  class Error < StandardError; end
+
+  # Raised when Keycloak answers with a non-2xx status.
+  #
+  # Callers can rescue the precise failure (KeycloakAdmin::NotFoundError), a whole family
+  # (KeycloakAdmin::ClientError for any 4xx) or every HTTP failure (KeycloakAdmin::ApiError),
+  # and read #status/#body off the exception rather than parsing the message.
+  class ApiError < Error
+    attr_reader :status, :body, :headers
+
+    def initialize(status, body, headers = {})
+      @status  = status
+      @body    = body
+      @headers = headers || {}
+      super("Keycloak: The request failed with response code #{status} and message: #{body}")
+    end
+
+    def self.from_response(response)
+      response ||= {}
+      status     = response[:status]
+      error_class_for(status).new(status, response[:body], response[:headers])
+    end
+
+    def self.error_class_for(status)
+      case status
+      when 400      then BadRequestError
+      when 401      then UnauthorizedError
+      when 403      then ForbiddenError
+      when 404      then NotFoundError
+      when 409      then ConflictError
+      when 400..499 then ClientError
+      when 500..599 then ServerError
+      else ApiError
+      end
+    end
+  end
+
+  # Any 4xx: the request itself was rejected.
+  class ClientError < ApiError; end
+
+  class BadRequestError   < ClientError; end
+  class UnauthorizedError < ClientError; end
+  class ForbiddenError    < ClientError; end
+  class NotFoundError     < ClientError; end
+  class ConflictError     < ClientError; end
+
+  # Any 5xx: Keycloak accepted the request but failed to serve it.
+  class ServerError < ApiError; end
+
+  # Raised when a create call succeeds at the HTTP level but answers something other than
+  # 201 Created, leaving no Location header to read the new resource's id from.
+  class UnexpectedResponseError < Error
+    attr_reader :status, :reason_phrase
+
+    def initialize(status, reason_phrase)
+      @status        = status
+      @reason_phrase = reason_phrase
+      super("Create method returned status #{reason_phrase} (Code: #{status}); expected status: Created (201)")
+    end
+  end
+end

data/lib/keycloak-admin/version.rb

@@ -1,3 +1,3 @@
 module KeycloakAdmin
-  VERSION = "2.0.0"
+  VERSION = "2.0.2"
 end

data/lib/keycloak-admin.rb

@@ -1,5 +1,6 @@
 require "logger"
 
+require_relative "keycloak-admin/error"
 require_relative "keycloak-admin/configuration"
 require_relative "keycloak-admin/client/response"
 require_relative "keycloak-admin/client/resource"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keycloak-admin
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Lorent Lempereur
@@ -85,6 +85,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Keycloak Admin REST API client written in Ruby
 email:
 - lorent.lempereur.dev@gmail.com
@@ -92,17 +120,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/Dockerfile"
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".rspec"
 - CHANGELOG.md
-- Dockerfile
-- Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
-- bin/console
 - keycloak-admin.gemspec
 - lib/keycloak-admin.rb
 - lib/keycloak-admin/client/attack_detection_client.rb
@@ -121,11 +141,14 @@ files:
 - lib/keycloak-admin/client/identity_provider_client.rb
 - lib/keycloak-admin/client/organization_client.rb
 - lib/keycloak-admin/client/realm_client.rb
+- lib/keycloak-admin/client/resource.rb
+- lib/keycloak-admin/client/response.rb
 - lib/keycloak-admin/client/role_client.rb
 - lib/keycloak-admin/client/role_mapper_client.rb
 - lib/keycloak-admin/client/token_client.rb
 - lib/keycloak-admin/client/user_client.rb
 - lib/keycloak-admin/configuration.rb
+- lib/keycloak-admin/error.rb
 - lib/keycloak-admin/representation/attack_detection_representation.rb
 - lib/keycloak-admin/representation/camel_json.rb
 - lib/keycloak-admin/representation/client_authz_permission_representation.rb
@@ -156,52 +179,14 @@ files:
 - lib/keycloak-admin/resource/group_resource.rb
 - lib/keycloak-admin/resource/user_resource.rb
 - lib/keycloak-admin/version.rb
-- spec/client/attack_detection_client_spec.rb
-- spec/client/client_authz_permission_client_spec.rb
-- spec/client/client_authz_policy_client_spec.rb
-- spec/client/client_authz_resource_client_spec.rb
-- spec/client/client_authz_scope_client_spec.rb
-- spec/client/client_client_spec.rb
-- spec/client/client_role_mappings_client_spec.rb
-- spec/client/client_scope_client_spec.rb
-- spec/client/client_scope_protocol_mapper_client_spec.rb
-- spec/client/client_spec.rb
-- spec/client/configurable_token_client_spec.rb
-- spec/client/group_client_spec.rb
-- spec/client/identity_provider_client_spec.rb
-- spec/client/organization_client_spec.rb
-- spec/client/realm_client_spec.rb
-- spec/client/role_client_spec.rb
-- spec/client/role_mapper_client_spec.rb
-- spec/client/token_client_spec.rb
-- spec/client/user_client_spec.rb
-- spec/configuration_spec.rb
-- spec/gemspec_spec.rb
-- spec/integration/client_authorization_spec.rb
-- spec/representation/attack_detection_representation_spec.rb
-- spec/representation/client_authz_permission_representation_spec.rb
-- spec/representation/client_authz_policy_representation_spec.rb
-- spec/representation/client_authz_resource_representation_spec.rb
-- spec/representation/client_authz_scope_representation_spec.rb
-- spec/representation/client_representation_spec.rb
-- spec/representation/client_scope_representation_spec.rb
-- spec/representation/credential_representation_spec.rb
-- spec/representation/group_representation_spec.rb
-- spec/representation/identity_provider_mapper_representation_spec.rb
-- spec/representation/identity_provider_representation_spec.rb
-- spec/representation/impersonation_representation_spec.rb
-- spec/representation/organization_representation_spec.rb
-- spec/representation/protocol_mapper_representation_spec.rb
-- spec/representation/role_representation_spec.rb
-- spec/representation/session_representation_spec.rb
-- spec/representation/user_representation_spec.rb
-- spec/resource/group_resource_spec.rb
-- spec/resource/user_resource_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/looorent/keycloak-admin-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/looorent/keycloak-admin-ruby
+  changelog_uri: https://github.com/looorent/keycloak-admin-ruby/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/looorent/keycloak-admin-ruby/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -216,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.17
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Keycloak Admin REST API client written in Ruby
 test_files: []

data/.github/workflows/Dockerfile

@@ -1,24 +0,0 @@
-### Dockerfile for: tillawy/keycloak-github-actions
-##
-## To build & push
-# docker buildx build . --platform linux/amd64 -t tillawy/keycloak-github-actions:25.0.1
-# docker push tillawy/keycloak-github-actions:25.0.1
-#
-## To Run Locally
-# docker run \
-#        --rm \
-#        -p 8080:8080 \
-#        -e KEYCLOAK_ADMIN="admin" \
-#        -e KEYCLOAK_ADMIN_PASSWORD="admin" \
-#        -e KC_HOSTNAME="http://localhost:8080" \
-#        -e KC_HOSTNAME_ADMIN="http://localhost:8080" \
-#        -e KC_HTTP_ENABLED="true" \
-#        -e KC_DB="dev-file" \
-#        tillawy/keycloak-github-actions:25.0.1
-
-FROM quay.io/keycloak/keycloak:25.0.1
-
-ENTRYPOINT ["/opt/keycloak/bin/kc.sh"]
-
-CMD ["start-dev", "--hostname=http://localhost:8080" , "--hostname-admin=http://localhost:8080" , "--http-enabled=true", "--verbose"]
-

data/.github/workflows/ci.yml

@@ -1,94 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Ruby
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-
-permissions:
-  contents: read
-
-jobs:
-  test:
-    name: Ruby ${{ matrix.ruby-version }}
-    runs-on: ubuntu-24.04
-
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby-version: ['3.1', '3.2', '3.3', '3.4']
-
-    steps:
-    - name: Start Keycloak
-      run: |
-        docker run -d --name keycloak -p 8080:8080 \
-          -e KC_BOOTSTRAP_ADMIN_USERNAME=admin \
-          -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin \
-          -e KC_HOSTNAME=http://localhost:8080 \
-          -e KC_HOSTNAME_ADMIN=http://localhost:8080 \
-          -e KC_HTTP_ENABLED=true \
-          -e KC_DB=dev-file \
-          quay.io/keycloak/keycloak:26.7.0 \
-          start-dev
-
-    - name: Wait for Keycloak to be ready
-      run: |
-        for i in $(seq 1 30); do
-          if curl --silent --fail http://localhost:8080/realms/master > /dev/null; then
-            echo "Keycloak is ready"
-            exit 0
-          fi
-          sleep 5
-        done
-        echo "Keycloak did not become ready in time"
-        docker logs keycloak
-        exit 1
-
-    - name: create realm
-      run: |
-         TOKEN=$(curl --silent --location --request POST "http://localhost:8080/realms/master/protocol/openid-connect/token" \
-            --header 'Content-Type: application/x-www-form-urlencoded' \
-            --data-urlencode 'grant_type=password' \
-            --data-urlencode 'username=admin' \
-            --data-urlencode 'password=admin' \
-            --data-urlencode 'client_id=admin-cli' | jq -r '.access_token')
-          
-         curl --silent --show-error -L -X POST "http://localhost:8080/admin/realms" \
-            --header "Content-Type: application/json" \
-            --header "Authorization: Bearer ${TOKEN}" \
-            --data '{"realm":"dummy","enabled":true}'
-        
-         curl --silent --show-error --request POST 'http://localhost:8080/admin/realms/dummy/clients' \
-           --header 'Authorization: Bearer '$TOKEN \
-           --header 'Content-Type: application/json' \
-           --data-raw '{
-             "clientId":"dummy-client",
-             "enabled":true,
-             "consentRequired": false,
-             "attributes":{},
-             "serviceAccountsEnabled": true,
-             "protocol":"openid-connect",
-             "publicClient":false,
-             "authorizationServicesEnabled": true,
-             "clientAuthenticatorType":"client-secret",
-             "redirectUris":["http://localhost:8180/demo"]
-           }'
-
-    - uses: actions/checkout@v6
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rspec
-      env:
-        GITHUB_ACTIONS: true

data/.gitignore

@@ -1,10 +0,0 @@
-.bundle/
-log/*.log
-pkg/
-test/dummy/db/*.sqlite3
-test/dummy/db/*.sqlite3-journal
-test/dummy/log/*.log
-test/dummy/tmp/
-*.gem
-.idea/
-.byebug_history

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,52 +0,0 @@
-PATH
-  remote: .
-  specs:
-    keycloak-admin (2.0.0)
-      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)
-    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!
-  rspec (= 3.13.2)
-
-BUNDLED WITH
-   2.6.9

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