keycloak-admin 0.6.5 → 0.7.4

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

@@ -0,0 +1,24 @@
+module KeycloakAdmin
+  class ClientClient < 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 list
+      response = execute_http do
+        RestClient::Resource.new(clients_url, @configuration.rest_client_options).get(headers)
+      end
+      JSON.parse(response).map { |client_as_hash| ClientRepresentation.from_hash(client_as_hash) }
+    end
+
+    def clients_url(id=nil)
+      if id
+        "#{@realm_client.realm_admin_url}/clients/#{id}"
+      else
+        "#{@realm_client.realm_admin_url}/clients"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module KeycloakAdmin
+  class ClientRoleMappingsClient < Client
+    def initialize(configuration, user_resource, client_id)
+      super(configuration)
+      @user_resource = user_resource
+      @client_id = client_id
+    end
+
+    def list_available
+      response = execute_http do
+        RestClient::Resource.new(list_available_url, @configuration.rest_client_options).get(headers)
+      end
+      JSON.parse(response).map { |role_as_hash| RoleRepresentation.from_hash(role_as_hash) }
+    end
+
+    def save(role_representation_list)
+      execute_http do
+        RestClient::Resource.new(base_url, @configuration.rest_client_options).post(
+          role_representation_list.to_json, headers
+        )
+      end
+    end
+
+    def list_available_url
+      "#{@user_resource.resource_url}/role-mappings/clients/#{@client_id}/available"
+    end
+
+    def base_url
+      "#{@user_resource.resource_url}/role-mappings/clients/#{@client_id}"
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+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 list
+      response = execute_http do
+        RestClient::Resource.new(groups_url, @configuration.rest_client_options).get(headers)
+      end
+      JSON.parse(response).map { |group_as_hash| GroupRepresentation.from_hash(group_as_hash) }
+    end
+
+    def create!(name, path = nil)
+      response = save(build(name, path))
+      created_id(response)
+    end
+
+    def save(group_representation)
+      execute_http do
+        RestClient::Resource.new(groups_url, @configuration.rest_client_options).post(
+          group_representation.to_json, headers
+        )
+      end
+    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)
+      group      = GroupRepresentation.new
+      group.name = name
+      group.path = path
+      group
+    end
+  end
+end

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

@@ -5,6 +5,36 @@ module KeycloakAdmin
       @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(
+          realm_representation.to_json, headers
+        )
+      end
+    end
+
+    def update(realm_representation_body)
+      execute_http do
+        RestClient::Resource.new(realm_admin_url, @configuration.rest_client_options).put(
+          realm_representation_body.to_json, headers
+        )
+      end
+    end
+
     def realm_url
       if @realm_name
         "#{server_url}/realms/#{@realm_name}"
@@ -21,6 +51,10 @@ module KeycloakAdmin
       end
     end
 
+    def realm_list_url
+      "#{server_url}/admin/realms"
+    end
+
     def token
       TokenClient.new(@configuration, self)
     end
@@ -29,10 +63,30 @@ module KeycloakAdmin
       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 users
       UserClient.new(@configuration, self)
     end
 
+    def user(user_id)
+      UserResource.new(@configuration, self, user_id)
+    end
+
     def name_defined?
       !@realm_name.nil?
     end

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

@@ -0,0 +1,32 @@
+module KeycloakAdmin
+  class RoleClient < 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 list
+      response = execute_http do
+        RestClient::Resource.new(roles_url, @configuration.rest_client_options).get(headers)
+      end
+      JSON.parse(response).map { |role_as_hash| RoleRepresentation.from_hash(role_as_hash) }
+    end
+
+    def save(role_representation)
+      execute_http do
+        RestClient::Resource.new(roles_url, @configuration.rest_client_options).post(
+          role_representation.to_json, headers
+        )
+      end
+    end
+
+    def roles_url(id=nil)
+      if id
+        "#{@realm_client.realm_admin_url}/roles/#{id}"
+      else
+        "#{@realm_client.realm_admin_url}/roles"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module KeycloakAdmin
+  class RoleMapperClient < Client
+    def initialize(configuration, user_resource)
+      super(configuration)
+      @user_resource = user_resource
+    end
+
+    def save_realm_level(role_representation_list)
+      execute_http do
+        RestClient::Resource.new(realm_level_url, @configuration.rest_client_options).post(
+          role_representation_list.to_json, headers
+        )
+      end
+    end
+
+    def realm_level_url
+      "#{@user_resource.resource_url}/role-mappings/realm"
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+require "rest-client"
+
 module KeycloakAdmin
   class TokenClient < Client
     def initialize(configuration, realm_client)
@@ -16,7 +18,10 @@ module KeycloakAdmin
 
     def get
       response = execute_http do
-        RestClient.post(token_url, @configuration.body_for_token_retrieval, @configuration.headers_for_token_retrieval)
+        RestClient::Resource.new(token_url, @configuration.rest_client_options).post(
+          @configuration.body_for_token_retrieval,
+          @configuration.headers_for_token_retrieval
+        )
       end
       TokenRepresentation.from_json(response.body)
     end

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

@@ -13,7 +13,9 @@ module KeycloakAdmin
 
     def save(user_representation)
       execute_http do
-        RestClient.post(users_url, user_representation.to_json, headers)
+        RestClient::Resource.new(users_url, @configuration.rest_client_options).post(
+          user_representation.to_json, headers
+        )
       end
       user_representation
     end
@@ -24,27 +26,37 @@ module KeycloakAdmin
 
     def get(user_id)
       response = execute_http do
-        RestClient.get(users_url(user_id), headers)
+        RestClient::Resource.new(users_url(user_id), @configuration.rest_client_options).get(headers)
       end
       UserRepresentation.from_hash(JSON.parse(response))
-    rescue
-      nil
     end
 
     def search(query)
+      derived_headers = query ? headers.merge({params: { search: query }}) : headers
       response = execute_http do
-        RestClient.get(users_url, headers.merge({params: { search: query }}))
+        RestClient::Resource.new(users_url, @configuration.rest_client_options).get(derived_headers)
       end
       JSON.parse(response).map { |user_as_hash| UserRepresentation.from_hash(user_as_hash) }
     end
 
+    def list
+      search(nil)
+    end
+
     def delete(user_id)
       execute_http do
-        RestClient.delete(users_url(user_id), headers)
+        RestClient::Resource.new(users_url(user_id), @configuration.rest_client_options).delete(headers)
       end
       true
     end
 
+    def groups(user_id)
+      response = execute_http do
+        RestClient::Resource.new(groups_url(user_id), @configuration.rest_client_options).get(headers)
+      end
+      JSON.parse(response).map { |group_as_hash| GroupRepresentation.from_hash(group_as_hash) }
+    end
+
     def update_password(user_id, new_password)
       execute_http do
         RestClient.put(reset_password_url(user_id), {
@@ -81,6 +93,11 @@ module KeycloakAdmin
       "#{users_url(user_id)}/reset-password"
     end
 
+    def groups_url(user_id)
+      raise ArgumentError.new("user_id must be defined") if user_id.nil?
+      "#{users_url(user_id)}/groups"
+    end
+
     def impersonation_url(user_id)
       raise ArgumentError.new("user_id must be defined") if user_id.nil?
       "#{users_url(user_id)}/impersonation"

data/lib/keycloak-admin/configuration.rb

@@ -2,7 +2,7 @@ require "base64"
 
 module KeycloakAdmin
   class Configuration
-    attr_accessor :server_url, :server_domain, :client_id, :client_secret, :client_realm_name, :use_service_account, :username, :password, :logger
+    attr_accessor :server_url, :server_domain, :client_id, :client_secret, :client_realm_name, :use_service_account, :username, :password, :logger, :rest_client_options
 
     def body_for_token_retrieval
       if use_service_account

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

@@ -5,7 +5,7 @@ module KeycloakAdmin
       if first_letter_in_uppercase
         lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
       else
-        lower_case_and_underscored_word.first + camelize(lower_case_and_underscored_word)[1..-1]
+        lower_case_and_underscored_word[0] + camelize(lower_case_and_underscored_word)[1..-1]
       end
     end
   end

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

@@ -0,0 +1,16 @@
+module KeycloakAdmin
+  class ClientRepresentation < Representation
+    attr_accessor :id,
+      :name,
+      :client_id
+    # TODO: Add more attributes
+
+    def self.from_hash(hash)
+      client           = new
+      client.id        = hash["id"]
+      client.name      = hash["name"]
+      client.client_id = hash["clientId"]
+      client
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module KeycloakAdmin
+  class GroupRepresentation < Representation
+    attr_accessor :id,
+      :name,
+      :path
+
+    def self.from_hash(hash)
+      group      = new
+      group.id   = hash["id"]
+      group.name = hash["name"]
+      group.path = hash["path"]
+      group
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module KeycloakAdmin
+  class RealmRepresentation < Representation
+    attr_accessor :id,
+      :realm
+    # TODO: Add more attributes
+
+    def self.from_hash(hash)
+      realm       = new
+      realm.id    = hash["id"]
+      realm.realm = hash["realm"]
+      realm
+    end
+  end
+end

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

@@ -1,10 +1,15 @@
+require "json"
 require_relative "camel_json"
 
 class Representation
   include ::KeycloakAdmin::CamelJson
 
+  def as_json(options=nil)
+    Hash[instance_variables.map { |ivar| [ivar.to_s[1..-1], instance_variable_get(ivar)] }]
+  end
+
   def to_json(options=nil)
-    snaked_hash = as_json
+    snaked_hash = as_json(options)
     snaked_hash.keys.reduce({}) do |camelized_hash, key|
       camelized_hash[camelize(key, false)] = snaked_hash[key]
       camelized_hash

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

@@ -0,0 +1,17 @@
+module KeycloakAdmin
+  class RoleRepresentation < Representation
+    attr_accessor :id,
+      :name,
+      :composite,
+      :client_role
+
+    def self.from_hash(hash)
+      role             = new
+      role.id          = hash["id"]
+      role.name        = hash["name"]
+      role.composite   = hash["composite"]
+      role.client_role = hash["clientRole"]
+      role
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module KeycloakAdmin
   class UserRepresentation < Representation
     attr_accessor :id,
-      :created_at,
+      :created_timestamp,
       :attributes,
       :origin,
       :username,
@@ -13,18 +13,18 @@ module KeycloakAdmin
       :credentials
 
     def self.from_hash(hash)
-      user                = new
-      user.id             = hash["id"]
-      user.created_at     = Time.at(hash["createdTimestamp"] / 1000).to_datetime
-      user.origin         = hash["origin"]
-      user.username       = hash["username"]
-      user.email          = hash["email"]
-      user.enabled        = hash["enabled"]
-      user.email_verified = hash["emailVerified"]
-      user.first_name     = hash["firstName"]
-      user.last_name      = hash["lastName"]
-      user.attributes     = hash["attributes"]
-      user.credentials    = hash["credentials"]&.map{ |hash| CredentialRepresentation.from_hash(hash) } || []
+      user                   = new
+      user.id                = hash["id"]
+      user.created_timestamp = hash["createdTimestamp"]
+      user.origin            = hash["origin"]
+      user.username          = hash["username"]
+      user.email             = hash["email"]
+      user.enabled           = hash["enabled"]
+      user.email_verified    = hash["emailVerified"]
+      user.first_name        = hash["firstName"]
+      user.last_name         = hash["lastName"]
+      user.attributes        = hash["attributes"]
+      user.credentials       = hash["credentials"]&.map{ |hash| CredentialRepresentation.from_hash(hash) } || []
       user
     end