keycloak-admin 1.1.3 → 1.1.4

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

@@ -1,131 +1,148 @@
-module KeycloakAdmin
-  class GroupClient < Client
-    def initialize(configuration, realm_client)
-      super(configuration)
-      raise ArgumentError.new("realm must be defined") unless realm_client.name_defined?
-      @realm_client = realm_client
-    end
-
-    def get(group_id)
-      response = execute_http do
-        RestClient::Resource.new(groups_url(group_id), @configuration.rest_client_options).get(headers)
-      end
-      GroupRepresentation.from_hash(JSON.parse(response))
-    end
-
-    def children(parent_id)
-      response = execute_http do
-        url = "#{groups_url(parent_id)}/children"
-        RestClient::Resource.new(url, @configuration.rest_client_options).get(headers)
-      end
-      JSON.parse(response).map { |group_as_hash| GroupRepresentation.from_hash(group_as_hash) }
-    end
-
-    def list
-      search(nil)
-    end
-
-    def search(query)
-      derived_headers = case query
-                        when String
-                          headers.merge({params: { search: query }})
-                        when Hash
-                          headers.merge({params: query })
-                        else
-                          headers
-                        end
-      response = execute_http do
-        RestClient::Resource.new(groups_url, @configuration.rest_client_options).get(derived_headers)
-      end
-      JSON.parse(response).map { |group_as_hash| GroupRepresentation.from_hash(group_as_hash) }
-    end
-
-    def create!(name, path = nil, attributes = {})
-      response = save(build(name, path, attributes))
-      created_id(response)
-    end
-
-    def save(group_representation)
-      execute_http do
-        payload = create_payload(group_representation)
-        if group_representation.id
-          RestClient::Resource.new(groups_url(group_representation.id), @configuration.rest_client_options).put(payload, headers)
-        else
-          RestClient::Resource.new(groups_url, @configuration.rest_client_options).post(payload, headers)
-        end
-      end
-    end
-
-    def create_subgroup!(parent_id, name, attributes = {})
-      url = "#{groups_url(parent_id)}/children"
-      response = execute_http do
-        RestClient::Resource.new(url, @configuration.rest_client_options).post(
-          create_payload(build(name, nil, attributes)), headers
-        )
-      end
-      created_id(response)
-    end
-
-    def delete(group_id)
-      execute_http do
-        RestClient::Resource.new(groups_url(group_id), @configuration.rest_client_options).delete(headers)
-      end
-      true
-    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
-
-    # Gets all realm-level roles for a group
-    def get_realm_level_roles(group_id)
-      url = "#{groups_url(group_id)}/role-mappings/realm"
-      response = execute_http do
-        RestClient::Resource.new(url, @configuration.rest_client_options).get(headers)
-      end
-      JSON.parse(response).map { |role_as_hash| RoleRepresentation.from_hash(role_as_hash) }
-    end
-
-    # Adds a realm-level role to a group via the role name
-    def add_realm_level_role_name!(group_id, role_name)
-      # creates a full role-representation object needed by the keycloak api to work
-      role_representation = RoleClient.new(@configuration, @realm_client).get(role_name)
-      url = "#{groups_url(group_id)}/role-mappings/realm"
-      response = execute_http do
-        RestClient::Resource.new(url, @configuration.rest_client_options).post(
-          create_payload([role_representation]), headers
-        )
-      end
-      role_representation
-    end
-
-    def groups_url(id=nil)
-      if id
-        "#{@realm_client.realm_admin_url}/groups/#{id}"
-      else
-        "#{@realm_client.realm_admin_url}/groups"
-      end
-    end
-
-    private
-
-    def build(name, path, attributes)
-      GroupRepresentation.from_hash(
-        {
-          "name" => name,
-          "path" => path,
-          "attributes" => attributes
-        }
-      )
-    end
-  end
-end
+module KeycloakAdmin
+  class GroupClient < Client
+    def initialize(configuration, realm_client)
+      super(configuration)
+      raise ArgumentError.new("realm must be defined") unless realm_client.name_defined?
+      @realm_client = realm_client
+    end
+
+    def get(group_id)
+      response = execute_http do
+        RestClient::Resource.new(groups_url(group_id), @configuration.rest_client_options).get(headers)
+      end
+      GroupRepresentation.from_hash(JSON.parse(response))
+    end
+
+    def children(parent_id)
+      response = execute_http do
+        url = "#{groups_url(parent_id)}/children"
+        RestClient::Resource.new(url, @configuration.rest_client_options).get(headers)
+      end
+      JSON.parse(response).map { |group_as_hash| GroupRepresentation.from_hash(group_as_hash) }
+    end
+
+    def list
+      search(nil)
+    end
+
+    def search(query)
+      derived_headers = case query
+                        when String
+                          headers.merge({params: { search: query }})
+                        when Hash
+                          headers.merge({params: query })
+                        else
+                          headers
+                        end
+      response = execute_http do
+        RestClient::Resource.new(groups_url, @configuration.rest_client_options).get(derived_headers)
+      end
+      JSON.parse(response).map { |group_as_hash| GroupRepresentation.from_hash(group_as_hash) }
+    end
+
+    def create!(name, path = nil, attributes = {})
+      response = save(build(name, path, attributes))
+      created_id(response)
+    end
+
+    def save(group_representation)
+      execute_http do
+        payload = create_payload(group_representation)
+        if group_representation.id
+          RestClient::Resource.new(groups_url(group_representation.id), @configuration.rest_client_options).put(payload, headers)
+        else
+          RestClient::Resource.new(groups_url, @configuration.rest_client_options).post(payload, headers)
+        end
+      end
+    end
+
+    def create_subgroup!(parent_id, name, attributes = {})
+      url = "#{groups_url(parent_id)}/children"
+      response = execute_http do
+        RestClient::Resource.new(url, @configuration.rest_client_options).post(
+          create_payload(build(name, nil, attributes)), headers
+        )
+      end
+      created_id(response)
+    end
+
+    def delete(group_id)
+      execute_http do
+        RestClient::Resource.new(groups_url(group_id), @configuration.rest_client_options).delete(headers)
+      end
+      true
+    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
+
+    # Gets all realm-level roles for a group
+    def get_realm_level_roles(group_id)
+      url = "#{groups_url(group_id)}/role-mappings/realm"
+      response = execute_http do
+        RestClient::Resource.new(url, @configuration.rest_client_options).get(headers)
+      end
+      JSON.parse(response).map { |role_as_hash| RoleRepresentation.from_hash(role_as_hash) }
+    end
+
+    # Adds a realm-level role to a group via the role name
+    def add_realm_level_role_name!(group_id, role_name)
+      # creates a full role-representation object needed by the keycloak api to work
+      role_representation = RoleClient.new(@configuration, @realm_client).get(role_name)
+      url = "#{groups_url(group_id)}/role-mappings/realm"
+      response = execute_http do
+        RestClient::Resource.new(url, @configuration.rest_client_options).post(
+          create_payload([role_representation]), headers
+        )
+      end
+      role_representation
+    end
+
+    # Remove a realm-level role from a group by the role name
+    def remove_realm_level_role_name!(group_id, role_name)
+      role_representation = RoleClient.new(@configuration, @realm_client).get(role_name)
+      url = "#{groups_url(group_id)}/role-mappings/realm"
+      execute_http do
+        RestClient::Request.execute(
+          @configuration.rest_client_options.merge(
+            url:,
+            method: :delete,
+            payload: create_payload([role_representation]),
+            headers: headers
+          )
+        )
+      end
+      true
+    end
+
+    def groups_url(id=nil)
+      if id
+        "#{@realm_client.realm_admin_url}/groups/#{id}"
+      else
+        "#{@realm_client.realm_admin_url}/groups"
+      end
+    end
+
+    private
+
+    def build(name, path, attributes)
+      GroupRepresentation.from_hash(
+        {
+          "name" => name,
+          "path" => path,
+          "attributes" => attributes
+        }
+      )
+    end
+  end
+end

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

@@ -1,51 +1,51 @@
-module KeycloakAdmin
-  class IdentityProviderClient < Client
-    def initialize(configuration, realm_client)
-      super(configuration)
-      raise ArgumentError.new("realm must be defined") unless realm_client.name_defined?
-      @realm_client = realm_client
-    end
-
-    def create(identity_provider_representation)
-      execute_http do
-        RestClient::Resource.new(identity_providers_url, @configuration.rest_client_options).post(
-          create_payload(identity_provider_representation), headers
-        )
-      end
-    end
-
-    def add_mapping(identity_provider_alias, identity_provider_mapping_representation)
-      execute_http do
-        RestClient::Resource.new(identity_provider_mappers_url(identity_provider_alias), @configuration.rest_client_options).post(
-          create_payload(identity_provider_mapping_representation), headers
-        )
-      end
-    end
-
-    def list
-      response = execute_http do
-        RestClient::Resource.new(identity_providers_url, @configuration.rest_client_options).get(headers)
-      end
-      JSON.parse(response).map { |provider_as_hash| IdentityProviderRepresentation.from_hash(provider_as_hash) }
-    end
-
-    def get(internal_id_or_alias=nil)
-      response = execute_http do
-        RestClient::Resource.new(identity_providers_url(internal_id_or_alias), @configuration.rest_client_options).get(headers)
-      end
-      IdentityProviderRepresentation.from_hash(JSON.parse(response))
-    end
-
-    def identity_providers_url(internal_id_or_alias=nil)
-      if internal_id_or_alias
-        "#{@realm_client.realm_admin_url}/identity-provider/instances/#{internal_id_or_alias}"
-      else
-        "#{@realm_client.realm_admin_url}/identity-provider/instances"
-      end
-    end
-
-    def identity_provider_mappers_url(internal_id_or_alias)
-      "#{identity_providers_url(internal_id_or_alias)}/mappers"
-    end
-  end
-end
+module KeycloakAdmin
+  class IdentityProviderClient < Client
+    def initialize(configuration, realm_client)
+      super(configuration)
+      raise ArgumentError.new("realm must be defined") unless realm_client.name_defined?
+      @realm_client = realm_client
+    end
+
+    def create(identity_provider_representation)
+      execute_http do
+        RestClient::Resource.new(identity_providers_url, @configuration.rest_client_options).post(
+          create_payload(identity_provider_representation), headers
+        )
+      end
+    end
+
+    def add_mapping(identity_provider_alias, identity_provider_mapping_representation)
+      execute_http do
+        RestClient::Resource.new(identity_provider_mappers_url(identity_provider_alias), @configuration.rest_client_options).post(
+          create_payload(identity_provider_mapping_representation), headers
+        )
+      end
+    end
+
+    def list
+      response = execute_http do
+        RestClient::Resource.new(identity_providers_url, @configuration.rest_client_options).get(headers)
+      end
+      JSON.parse(response).map { |provider_as_hash| IdentityProviderRepresentation.from_hash(provider_as_hash) }
+    end
+
+    def get(internal_id_or_alias=nil)
+      response = execute_http do
+        RestClient::Resource.new(identity_providers_url(internal_id_or_alias), @configuration.rest_client_options).get(headers)
+      end
+      IdentityProviderRepresentation.from_hash(JSON.parse(response))
+    end
+
+    def identity_providers_url(internal_id_or_alias=nil)
+      if internal_id_or_alias
+        "#{@realm_client.realm_admin_url}/identity-provider/instances/#{internal_id_or_alias}"
+      else
+        "#{@realm_client.realm_admin_url}/identity-provider/instances"
+      end
+    end
+
+    def identity_provider_mappers_url(internal_id_or_alias)
+      "#{identity_providers_url(internal_id_or_alias)}/mappers"
+    end
+  end
+end

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

@@ -1,122 +1,122 @@
-module KeycloakAdmin
-  class RealmClient < Client
-    def initialize(configuration, realm_name=nil)
-      super(configuration)
-      @realm_name = realm_name
-    end
-
-    def list
-      response = execute_http do
-        RestClient::Resource.new(realm_list_url, @configuration.rest_client_options).get(headers)
-      end
-      JSON.parse(response).map { |realm_as_hash| RealmRepresentation.from_hash(realm_as_hash) }
-    end
-
-    def delete
-      execute_http do
-        RestClient::Resource.new(realm_admin_url, @configuration.rest_client_options).delete(headers)
-      end
-      true
-    end
-
-    def save(realm_representation)
-      execute_http do
-        RestClient::Resource.new(realm_list_url, @configuration.rest_client_options).post(
-          create_payload(realm_representation), headers
-        )
-      end
-    end
-
-    def update(realm_representation_body)
-      execute_http do
-        RestClient::Resource.new(realm_admin_url, @configuration.rest_client_options).put(
-          create_payload(realm_representation_body), headers
-        )
-      end
-    end
-
-    def realm_url
-      if @realm_name
-        "#{server_url}/realms/#{@realm_name}"
-      else
-        "#{server_url}/realms"
-      end
-    end
-
-    def realm_admin_url
-      if @realm_name
-        "#{server_url}/admin/realms/#{@realm_name}"
-      else
-        "#{server_url}/admin/realms"
-      end
-    end
-
-    def realm_list_url
-      "#{server_url}/admin/realms"
-    end
-
-    def token
-      TokenClient.new(@configuration, self)
-    end
-
-    def configurable_token
-      ConfigurableTokenClient.new(@configuration, self)
-    end
-
-    def clients
-      ClientClient.new(@configuration, self)
-    end
-
-    def groups
-      GroupClient.new(@configuration, self)
-    end
-
-    def group(group_id)
-      GroupResource.new(@configuration, self, group_id)
-    end
-
-    def roles
-      RoleClient.new(@configuration, self)
-    end
-
-    def client_roles
-      ClientRoleClient.new(@configuration, self)
-    end
-
-    def users
-      UserClient.new(@configuration, self)
-    end
-
-    def attack_detections
-      AttackDetectionClient.new(@configuration, self)
-    end
-
-    def identity_providers
-      IdentityProviderClient.new(@configuration, self)
-    end
-
-    def user(user_id)
-      UserResource.new(@configuration, self, user_id)
-    end
-
-    def authz_scopes(client_id, resource_id = nil)
-      ClientAuthzScopeClient.new(@configuration, self, client_id, resource_id)
-    end
-
-    def authz_resources(client_id)
-      ClientAuthzResourceClient.new(@configuration, self, client_id)
-    end
-
-    def authz_permissions(client_id, type, resource_id = nil)
-      ClientAuthzPermissionClient.new(@configuration, self, client_id, type, resource_id)
-    end
-
-    def authz_policies(client_id, type)
-      ClientAuthzPolicyClient.new(@configuration, self, client_id, type)
-    end
-
-    def name_defined?
-      !@realm_name.nil?
-    end
-  end
-end
+module KeycloakAdmin
+  class RealmClient < Client
+    def initialize(configuration, realm_name=nil)
+      super(configuration)
+      @realm_name = realm_name
+    end
+
+    def list
+      response = execute_http do
+        RestClient::Resource.new(realm_list_url, @configuration.rest_client_options).get(headers)
+      end
+      JSON.parse(response).map { |realm_as_hash| RealmRepresentation.from_hash(realm_as_hash) }
+    end
+
+    def delete
+      execute_http do
+        RestClient::Resource.new(realm_admin_url, @configuration.rest_client_options).delete(headers)
+      end
+      true
+    end
+
+    def save(realm_representation)
+      execute_http do
+        RestClient::Resource.new(realm_list_url, @configuration.rest_client_options).post(
+          create_payload(realm_representation), headers
+        )
+      end
+    end
+
+    def update(realm_representation_body)
+      execute_http do
+        RestClient::Resource.new(realm_admin_url, @configuration.rest_client_options).put(
+          create_payload(realm_representation_body), headers
+        )
+      end
+    end
+
+    def realm_url
+      if @realm_name
+        "#{server_url}/realms/#{@realm_name}"
+      else
+        "#{server_url}/realms"
+      end
+    end
+
+    def realm_admin_url
+      if @realm_name
+        "#{server_url}/admin/realms/#{@realm_name}"
+      else
+        "#{server_url}/admin/realms"
+      end
+    end
+
+    def realm_list_url
+      "#{server_url}/admin/realms"
+    end
+
+    def token
+      TokenClient.new(@configuration, self)
+    end
+
+    def configurable_token
+      ConfigurableTokenClient.new(@configuration, self)
+    end
+
+    def clients
+      ClientClient.new(@configuration, self)
+    end
+
+    def groups
+      GroupClient.new(@configuration, self)
+    end
+
+    def group(group_id)
+      GroupResource.new(@configuration, self, group_id)
+    end
+
+    def roles
+      RoleClient.new(@configuration, self)
+    end
+
+    def client_roles
+      ClientRoleClient.new(@configuration, self)
+    end
+
+    def users
+      UserClient.new(@configuration, self)
+    end
+
+    def attack_detections
+      AttackDetectionClient.new(@configuration, self)
+    end
+
+    def identity_providers
+      IdentityProviderClient.new(@configuration, self)
+    end
+
+    def user(user_id)
+      UserResource.new(@configuration, self, user_id)
+    end
+
+    def authz_scopes(client_id, resource_id = nil)
+      ClientAuthzScopeClient.new(@configuration, self, client_id, resource_id)
+    end
+
+    def authz_resources(client_id)
+      ClientAuthzResourceClient.new(@configuration, self, client_id)
+    end
+
+    def authz_permissions(client_id, type, resource_id = nil)
+      ClientAuthzPermissionClient.new(@configuration, self, client_id, type, resource_id)
+    end
+
+    def authz_policies(client_id, type)
+      ClientAuthzPolicyClient.new(@configuration, self, client_id, type)
+    end
+
+    def name_defined?
+      !@realm_name.nil?
+    end
+  end
+end