keycloak-admin 1.0.19 → 1.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67ccb78dc55dca61ad8dd44cb0f131dbe1b7a6b6c6449dd68c51fc981ef5439c
-  data.tar.gz: 7d3d483d4c1d26b430abc1accb326a7a371cc18c39fdde00845c2ed53dc79593
+  metadata.gz: 1a01d12df8eb75fcedbf128aacae50192983a47cb4cfac6c52b1dff4d999aa08
+  data.tar.gz: dae8911b975b7aea1989fc8df565047c144da55868569da02039c53fbc8d6963
 SHA512:
-  metadata.gz: 5ef5313937cb5b1442aaf182f10d020a893c86b6d5ce88950f9caa9bde8c115345c48b47b1a2598b49d85e76dbad1d7eea967a8dbc3655d07cfbf152d83471a9
-  data.tar.gz: a0373bba411c1e642220b61b25dc790727aad1738a60ca8e0141539eb7f8468eaae73d963255d7fd845072c9feca9530336da658c2a12e041c07218a61d1cf3a
+  metadata.gz: 8f44444327adcb4622856a7397401b5eaeaa10ad55943cce4606f4539340795a2e444f48613c35cdedb41c34431516b9137fec07f163d51c5e7c691ce3a7db17
+  data.tar.gz: 2210584caebc4c01e67a7da99740910755759a1edb22fb5c48002c0e51eb3d672460a74723db38bdc0bc639c2effd1cc42e4a8d30b79e185ce0d31a3a6c8ea72

data/CHANGELOG.md

@@ -5,10 +5,20 @@ 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.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 @Kazhuu) 
-* Get role by name (thanks to @Kazhuu) 
+* Remove specific realm roles from user (thanks to @tlloydthwaites) 
+* Get role by name (thanks to @tlloydthwaites) 
 
 ## [1.0.18] - 2022-11-24
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    keycloak-admin (1.0.19)
+    keycloak-admin (1.0.21)
       http-cookie (~> 1.0, >= 1.0.3)
       rest-client (~> 2.1)
 
@@ -30,10 +30,10 @@ GEM
       rspec-mocks (~> 3.12.0)
     rspec-core (3.12.0)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.0)
+    rspec-expectations (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.0)
+    rspec-mocks (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)

data/README.md

@@ -12,7 +12,7 @@ This gem *does not* require Rails.
 For example, using `bundle`, add this line to your Gemfile.
 
 ```ruby
-gem "keycloak-admin", "1.0.19"
+gem "keycloak-admin", "1.0.21"
 ```
 
 ## Login
@@ -119,6 +119,7 @@ All options have a default value. However, all of them can be changed in your in
 * Get list of roles, save a role
 * Get list of realms, save/update/delete a realm
 * Get list of client role mappings for a user/group
+* Get list of members of a group
 * Save client role mappings for a user/group
 * Save realm-level role mappings for a user/group
 * Add a Group on a User
@@ -310,6 +311,30 @@ group_path = "/top"
 group_id = KeycloakAdmin.realm("a_realm").groups.create!(group_name, group_path)
 ```
 
+### Create a new subgroup of an existing group
+
+Create a new group as the child of an existing group.
+
+```ruby
+parent_id = "7686af34-204c-4515-8122-78d19febbf6e"
+group_name = "test"
+sub_group_id = KeycloakAdmin.realm("a_realm").groups.create_subgroup!(parent_id, group_name)
+```
+
+### Get list of members of a group
+
+Returns an array of `KeycloakAdmin::UserRepresentation`.
+
+```ruby
+KeycloakAdmin.realm("a_realm").group("group_id").members
+```
+
+You can specify paging with `first` and `max`:
+
+```ruby
+KeycloakAdmin.realm("a_realm").group("group_id").members(first:0, max:100)
+```
+
 ### Get list of roles in a realm
 
 Returns an array of `KeycloakAdmin::RoleRepresentation`.

data/lib/keycloak-admin/client/group_client.rb

@@ -26,6 +26,29 @@ module KeycloakAdmin
       end
     end
 
+    def create_subgroup!(parent_id, name)
+      url = "#{groups_url(parent_id)}/children"
+      response = execute_http do
+        RestClient::Resource.new(url, @configuration.rest_client_options).post(
+          create_payload(build(name, nil)), headers
+        )
+      end
+      created_id(response)
+    end
+    
+    def members(group_id, first=0, max=100)
+      url = "#{groups_url(group_id)}/members"
+      query = {first: first.try(:to_i), max: max.try(:to_i)}.compact
+      unless query.empty?
+        query_string = query.to_a.map { |e| "#{e[0]}=#{e[1]}" }.join("&")
+        url = "#{url}?#{query_string}"
+      end
+      response = execute_http do
+        RestClient::Resource.new(url, @configuration.rest_client_options).get(headers)
+      end
+      JSON.parse(response).map { |user_as_hash| UserRepresentation.from_hash(user_as_hash) }
+    end
+
     def groups_url(id=nil)
       if id
         "#{@realm_client.realm_admin_url}/groups/#{id}"

data/lib/keycloak-admin/representation/group_representation.rb

@@ -2,13 +2,15 @@ module KeycloakAdmin
   class GroupRepresentation < Representation
     attr_accessor :id,
       :name,
-      :path
+      :path,
+      :sub_groups
 
     def self.from_hash(hash)
-      group      = new
-      group.id   = hash["id"]
-      group.name = hash["name"]
-      group.path = hash["path"]
+      group            = new
+      group.id         = hash["id"]
+      group.name       = hash["name"]
+      group.path       = hash["path"]
+      group.sub_groups = hash.fetch("subGroups", []).map { |sub_group_hash| self.from_hash(sub_group_hash) }
       group
     end
   end

data/lib/keycloak-admin/resource/base_role_containing_resource.rb

@@ -1,5 +1,7 @@
 module KeycloakAdmin
   class BaseRoleContainingResource
+    attr_reader :resource_id
+
     def initialize(configuration, realm_client, resource_id)
       @configuration = configuration
       raise ArgumentError.new("realm must be defined") unless realm_client.name_defined?

data/lib/keycloak-admin/resource/group_resource.rb

@@ -3,5 +3,9 @@ module KeycloakAdmin
     def resources_name
       "groups"
     end
+    
+    def members(first:0, max:100)
+      @realm_client.groups.members(@resource_id, first, max)
+    end
   end
 end

data/lib/keycloak-admin/version.rb

@@ -1,3 +1,3 @@
 module KeycloakAdmin
-  VERSION = "1.0.19"
+  VERSION = "1.0.21"
 end

data/spec/client/group_client_spec.rb

@@ -111,15 +111,26 @@ RSpec.describe KeycloakAdmin::GroupClient do
         'Create method returned status OK (Code: 200); expected status: Created (201)'
       )
     end
+  end
 
-    def stub_net_http_res(res_class, code, message)
-      net_http_res = double
-      allow(net_http_res).to receive(:message).and_return message
-      allow(net_http_res).to receive(:code).and_return code
-      allow(net_http_res).to receive(:is_a?) do |target_class|
-        target_class == res_class
-      end
-      allow(@response).to receive(:net_http_res).and_return net_http_res
+  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'
+      }
+      allow_any_instance_of(RestClient::Resource).to receive(:post).and_return @response
+    end
+
+    it "creates a subgroup" do
+      stub_net_http_res(Net::HTTPCreated, 201, 'Created')
+
+      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
 end

data/spec/representation/group_representation_spec.rb

@@ -0,0 +1,15 @@
+
+RSpec.describe KeycloakAdmin::GroupRepresentation do
+  describe ".from_hash" do
+    it "parses the sub groups into group representations" do
+      group = described_class.from_hash({
+        "name" => "group a",
+        "subGroups" => [{
+          "name" => "subgroup b"
+        }]
+      })
+      expect(group.sub_groups.length).to eq 1
+      expect(group.sub_groups.first).to be_a described_class
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -10,7 +10,7 @@ def configure
     config.client_secret       = "aaaaaaaa"
     config.client_realm_name   = "master2"
     config.use_service_account = true
-  end 
+  end
 end
 
 RSpec.configure do |config|
@@ -27,3 +27,11 @@ def stub_token_client
     'refresh_expires_in', 'id_token', 'not_before_policy', 'session_state'
   )
 end
+
+def stub_net_http_res(res_class, code, message)
+  net_http_res = double(message:  message, code: code)
+  allow(net_http_res).to receive(:is_a?) do |target_class|
+    target_class == res_class
+  end
+  allow(@response).to receive(:net_http_res).and_return(net_http_res)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak-admin
 version: !ruby/object:Gem::Version
-  version: 1.0.19
+  version: 1.0.21
 platform: ruby
 authors:
 - Lorent Lempereur
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-03 00:00:00.000000000 Z
+date: 2023-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-cookie
@@ -134,6 +134,7 @@ files:
 - spec/client/user_client_spec.rb
 - spec/configuration_spec.rb
 - spec/representation/client_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
@@ -147,7 +148,7 @@ homepage: https://github.com/looorent/keycloak-admin-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -162,8 +163,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Keycloak Admin REST API client written in Ruby
 test_files: []