keycloak-admin 1.1.2 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75a9e29c443612983e789a4d2d38d050908a0239fd4b74bca5f5d722234ef940
-  data.tar.gz: e0bf740884bb1da5bf3c63032f6349e46f98ce56f1b06f0ae62dcb96eb324bb7
+  metadata.gz: a699842f0de47c278828c7874187d0249313d7ff871642a6f26bef4aa202999e
+  data.tar.gz: 6cd358f9db2f837705326e35b6bc00064575ca41e41e08a0fbf04d71d7a76dd1
 SHA512:
-  metadata.gz: 1cc1adf071a240af23ace33f0f48d3b4c9cee0868dc4e50acab30d900bc0575fd4784bd725869dff58e79c053e4b6505376569855fbdb647bf929b8d82190277
-  data.tar.gz: e34ae74e3096db9fa6ac6c92370eed71e23e25a4d896a98eed1afb68cfeb422d66ad99eb5d4a02460bd7fa3a6b57b2c6b351bfb42d4adb7fcdab70fc838f4825
+  metadata.gz: 849ddd89962850c4e7b541591072e50f34d639b1c2d6dc0fe5e189d4f64ed9e2aa3354d20ffec8097fe5737d6aa0b7117aeb7dd9c0fd93f23ca2a6e6cf0ac2b3
+  data.tar.gz: 2d6057ebd0fea9d52c096be0c8bd4ecfc209cabad8b5e9d7edb95d5fddcd391c7bba3ddde127a51ff313ba42a7ccd213ff9abdf1fafdf57640f5fdc013aa66a7

data/.github/workflows/Dockerfile

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

@@ -0,0 +1,80 @@
+# 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:
+    runs-on: ubuntu-latest
+    services:
+      keycloak:
+        image: tillawy/keycloak-github-actions:25.0.1
+        ports:
+          - 8080:8080
+        options: '--health-cmd "exec 3<>/dev/tcp/localhost/8080" --health-interval 5s --health-timeout 5s --health-retries 10 --health-start-period 100s'
+        env:
+          KEYCLOAK_ADMIN: "admin"
+          KEYCLOAK_ADMIN_PASSWORD: "admin"
+          KC_HOSTNAME: "http://localhost:8080"
+          KC_HOSTNAME_ADMIN: "http://localhost:8080"
+          KC_HTTP_ENABLED: "true"
+          KC_DB: "dev-file"
+
+    strategy:
+      matrix:
+        ruby-version: ['3.2']
+
+    steps:
+    - 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@v4
+    - 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 +1,10 @@
-.bundle/
-log/*.log
-pkg/
-test/dummy/db/*.sqlite3
-test/dummy/db/*.sqlite3-journal
-test/dummy/log/*.log
-test/dummy/tmp/
-*.gem
-.idea/
+.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 +1,2 @@
---color
---require spec_helper
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -1,184 +1,195 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [1.1.2] - 2024-05-22
-
-* Add group endpoints (get, children, delete), support for group attributes (thanks to @mkrawc)
-* GroupClient#save method now can update an existing group (thanks to @mkrawc)
-* RoleClient#save method now can update an existing role (thanks to @mkrawc)
-
-## [1.1.1] - 2024-01-21
-
-* Add/List realm-role/s to a group, Allow role-names with spaces, List groups assigned to role (thanks to @LiquidMagical)
-
-## [1.1.0] - 2023-10-03
-
-* Search for groups with parameters (thanks to @@tlloydthwaites)
-* Get client by ID, Find client by Client ID, Update Client (thanks to @gee-forr)
-
-## [1.0.24] - 2023-06-07
-
-* Revert the modifications on the feature 'Update a User' introduced in `1.0.22`. This implementation had breaking changes such as not being able to update several attributes (`first_name`, `email`, etc).
-
-## [1.0.23] - 2023-06-01
-
-* Be more permissive about the version of `rest-client` (`~> 2.0`) (thanks to @type-face)
-
-## [1.0.22] - 2023-05-29
-
-* Fetch user's all active sessions (thanks to @prsanjay)
-* Check whether a user is locked or not (thanks to @prsanjay)
-* Logout users from all the active sessions (thanks to @prsanjay)
-
-## [1.0.21] - 2023-02-03
-
-* List users who are a member of a group (thanks to @tlloydthwaites) 
-
-## [1.0.20] - 2022-12-26
-
-* Create subgroups (thanks to @neckhair)
-* Add subgroups to `GroupRepresentation` (thanks to @neckhair)
-* Expose `BaseRoleContainingResource.resource_id` (thanks to @neckhair)
-
-## [1.0.19] - 2022-12-03
-
-* Remove specific realm roles from user (thanks to @tlloydthwaites) 
-* Get role by name (thanks to @tlloydthwaites) 
-
-## [1.0.18] - 2022-11-24
-
-* List user realm-level role mappings (thanks to @Kazhuu) 
-
-## [1.0.17] - 2022-11-02
-
-* Delete `Client` 
-
-## [1.0.16] - 2022-10-15
-
-* Remove `rest-client` warning when adding a group (thanks to @tlloydthwaites)
-
-## [1.0.15] - 2022-05-23
-
-* Delete all "realm" roles mapped to a user
-
-## [1.0.14] - 2022-03-30
-
-* Update `Gemfile.lock` to avoid wrong CVE detections. The version of Rails should always be specified by the parent project. This change has no functional impact.
-
-## [1.0.13] - 2022-03-13
-
-* Add client role on users
-* List client roles
-
-## [1.0.7] - 2022-03-13
-
-* Allow to use multiple `KeycloakAdmin::Client` in the same environment 
-
-## [1.0.6] - 2022-03-13
-
-* When serializing an array to JSON, force the serialization to use `to_json` for each element. In several contexts (e.g. Rails), `to_json` is not used.
-
-## [1.0.5] - 2022-03-11
-
-* Create `Client`
-* Create `Identity Provider` (Breaking change: `IdentityProviderRepresentation.configuration` has been renamed to `IdentityProviderRepresentation.config`)
-* Add `Identity Provider Mapping`
-* Find service account for a `Client`
-
-## [1.0.1] - 2021-10-14
-
-* List all `Identity Providers`
-* Add Group on Users (thanks to @tomuench)
-* Remove Group from Users (thanks to @tomuench)
-
-## [1.0.0] - 2021-08-03
-
-* Add `totp` on Users
-* Add `required_actions` on Users
-
-## [0.7.9] - 2020-10-22
-
-* Extend `search` function to use complex queries (thanks to @hobbypunk90)
-
-## [0.7.8] - 2020-10-15
-
-* Bug: `rest_client_options` default value does not match the documentation (was `nil` by default, should be `{}`)
-* Update documentation about client setup (based on Keycloak 11)
-
-## [0.7.7] - 2020-07-10
-
-* Fix: `Replace request method shorthand with .execute for proper RestClient option support` (thanks to @RomanHargrave)
-* When sending action emails, add lifespan as an optional parameter (thanks to @hobbypunk90)
-
-## [0.7.6] - 2020-06-22
-
-Thanks to @hobbypunk90 
-* Support for action emails and send forgot passsword mail 
-
-## [0.7.5] - 2020-03-28
-
-Thanks to @RomanHargrave
-* Support for working with federated identity provider (broker) links
-
-## [0.7.4] - 2019-10-17
-
-* Support for Rails 6
-
-## [0.7.3] - 2019-07-11
-
-Thanks to @cederigo:
-* For a given user, get her list of groups
-
-## [0.7.2] - 2019-06-17
-
-Thanks to @vlad-ro:
-
-* Get list of client role mappings for a group
-* Save client role mappings for a user/group
-* Save realm-level role mappings for a user/group
-
-## [0.7.1] - 2019-06-11
-
-Thanks to @vlad-ro:
-
-* List users
-* List clients
-* List groups, create/save a group
-* List roles, save a role
-* List realms, save/update/delete a realm
-* Get list of client role mappings for a user
-* Support passing rest client options for user save and search
-* Support using gem without ActiveSupport
-
-## [0.7.0] - 2019-06-06
-
-Thanks to @vlad-ro:
-
-* Support passing rest client options
-* More documentation
-* More tests
-* Better handling of timeouts
-
-## [0.6.5] - 2019-05-14
-
-* Get user
-
-## [0.6.2] - 2019-05-14
-
-* Update users
-
-## [0.6] - 2019-03-06
-
-* Save a locale when creating a new user
-
-## [0.5] - 2018-01-26
-
-* Client to access Custom REST API configurable-token
-
-## [0.3] - 2018-01-19
-
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.1.4] - 2025-11-08
+
+* Add remove_realm_level_role_name! action on a GroupClient (thanks to @mkrawc)
+* Dependencies: Update Gemfile.lock to bump byebug → 12.0.0, rspec → 3.13.2, and related dependencies
+* Bug: The 'remove' operation of the 'RoleMapperClient' does not take the global rest options into account
+
+## [1.1.3] - 2024-07-12
+
+* Client Authorization management support (thanks to @tillawy)
+* GitHub-actions setup to execute `rspec` (thanks to @tillawy)
+
+## [1.1.2] - 2024-05-22
+
+* Add group endpoints (get, children, delete), support for group attributes (thanks to @mkrawc)
+* GroupClient#save method now can update an existing group (thanks to @mkrawc)
+* RoleClient#save method now can update an existing role (thanks to @mkrawc)
+
+## [1.1.1] - 2024-01-21
+
+* Add/List realm-role/s to a group, Allow role-names with spaces, List groups assigned to role (thanks to @LiquidMagical)
+
+## [1.1.0] - 2023-10-03
+
+* Search for groups with parameters (thanks to @@tlloydthwaites)
+* Get client by ID, Find client by Client ID, Update Client (thanks to @gee-forr)
+
+## [1.0.24] - 2023-06-07
+
+* Revert the modifications on the feature 'Update a User' introduced in `1.0.22`. This implementation had breaking changes such as not being able to update several attributes (`first_name`, `email`, etc).
+
+## [1.0.23] - 2023-06-01
+
+* Be more permissive about the version of `rest-client` (`~> 2.0`) (thanks to @type-face)
+
+## [1.0.22] - 2023-05-29
+
+* Fetch user's all active sessions (thanks to @prsanjay)
+* Check whether a user is locked or not (thanks to @prsanjay)
+* Logout users from all the active sessions (thanks to @prsanjay)
+
+## [1.0.21] - 2023-02-03
+
+* List users who are a member of a group (thanks to @tlloydthwaites) 
+
+## [1.0.20] - 2022-12-26
+
+* Create subgroups (thanks to @neckhair)
+* Add subgroups to `GroupRepresentation` (thanks to @neckhair)
+* Expose `BaseRoleContainingResource.resource_id` (thanks to @neckhair)
+
+## [1.0.19] - 2022-12-03
+
+* Remove specific realm roles from user (thanks to @tlloydthwaites) 
+* Get role by name (thanks to @tlloydthwaites) 
+
+## [1.0.18] - 2022-11-24
+
+* List user realm-level role mappings (thanks to @Kazhuu) 
+
+## [1.0.17] - 2022-11-02
+
+* Delete `Client` 
+
+## [1.0.16] - 2022-10-15
+
+* Remove `rest-client` warning when adding a group (thanks to @tlloydthwaites)
+
+## [1.0.15] - 2022-05-23
+
+* Delete all "realm" roles mapped to a user
+
+## [1.0.14] - 2022-03-30
+
+* Update `Gemfile.lock` to avoid wrong CVE detections. The version of Rails should always be specified by the parent project. This change has no functional impact.
+
+## [1.0.13] - 2022-03-13
+
+* Add client role on users
+* List client roles
+
+## [1.0.7] - 2022-03-13
+
+* Allow to use multiple `KeycloakAdmin::Client` in the same environment 
+
+## [1.0.6] - 2022-03-13
+
+* When serializing an array to JSON, force the serialization to use `to_json` for each element. In several contexts (e.g. Rails), `to_json` is not used.
+
+## [1.0.5] - 2022-03-11
+
+* Create `Client`
+* Create `Identity Provider` (Breaking change: `IdentityProviderRepresentation.configuration` has been renamed to `IdentityProviderRepresentation.config`)
+* Add `Identity Provider Mapping`
+* Find service account for a `Client`
+
+## [1.0.1] - 2021-10-14
+
+* List all `Identity Providers`
+* Add Group on Users (thanks to @tomuench)
+* Remove Group from Users (thanks to @tomuench)
+
+## [1.0.0] - 2021-08-03
+
+* Add `totp` on Users
+* Add `required_actions` on Users
+
+## [0.7.9] - 2020-10-22
+
+* Extend `search` function to use complex queries (thanks to @hobbypunk90)
+
+## [0.7.8] - 2020-10-15
+
+* Bug: `rest_client_options` default value does not match the documentation (was `nil` by default, should be `{}`)
+* Update documentation about client setup (based on Keycloak 11)
+
+## [0.7.7] - 2020-07-10
+
+* Fix: `Replace request method shorthand with .execute for proper RestClient option support` (thanks to @RomanHargrave)
+* When sending action emails, add lifespan as an optional parameter (thanks to @hobbypunk90)
+
+## [0.7.6] - 2020-06-22
+
+Thanks to @hobbypunk90 
+* Support for action emails and send forgot passsword mail 
+
+## [0.7.5] - 2020-03-28
+
+Thanks to @RomanHargrave
+* Support for working with federated identity provider (broker) links
+
+## [0.7.4] - 2019-10-17
+
+* Support for Rails 6
+
+## [0.7.3] - 2019-07-11
+
+Thanks to @cederigo:
+* For a given user, get her list of groups
+
+## [0.7.2] - 2019-06-17
+
+Thanks to @vlad-ro:
+
+* Get list of client role mappings for a group
+* Save client role mappings for a user/group
+* Save realm-level role mappings for a user/group
+
+## [0.7.1] - 2019-06-11
+
+Thanks to @vlad-ro:
+
+* List users
+* List clients
+* List groups, create/save a group
+* List roles, save a role
+* List realms, save/update/delete a realm
+* Get list of client role mappings for a user
+* Support passing rest client options for user save and search
+* Support using gem without ActiveSupport
+
+## [0.7.0] - 2019-06-06
+
+Thanks to @vlad-ro:
+
+* Support passing rest client options
+* More documentation
+* More tests
+* Better handling of timeouts
+
+## [0.6.5] - 2019-05-14
+
+* Get user
+
+## [0.6.2] - 2019-05-14
+
+* Update users
+
+## [0.6] - 2019-03-06
+
+* Save a locale when creating a new user
+
+## [0.5] - 2018-01-26
+
+* Client to access Custom REST API configurable-token
+
+## [0.3] - 2018-01-19
+
 * Support of impersonation

data/Dockerfile

@@ -1,13 +1,13 @@
-FROM ruby:3.2.2-slim-bullseye
-
-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
+FROM ruby:3.2.2-slim-bullseye
+
+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 +1,3 @@
-source 'https://rubygems.org'
-
-gemspec
+source 'https://rubygems.org'
+
+gemspec