keycloak-admin 0.6.5 → 0.7.4

data/spec/client/role_client_spec.rb

@@ -0,0 +1,83 @@
+RSpec.describe KeycloakAdmin::RoleClient do
+  describe "#roles_url" do
+    let(:realm_name) { "valid-realm" }
+    let(:role_id)    { nil }
+
+    before(:each) do
+      @built_url = KeycloakAdmin.realm(realm_name).roles.roles_url(role_id)
+    end
+
+    context "when role_id is not defined" do
+      let(:role_id) { nil }
+      it "return a proper url without role id" do
+        expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/roles"
+      end
+    end
+
+    context "when role_id is defined" do
+      let(:role_id) { "95985b21-d884-4bbd-b852-cb8cd365afc2" }
+      it "return a proper url with the role id" do
+        expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/roles/95985b21-d884-4bbd-b852-cb8cd365afc2"
+      end
+    end
+  end
+
+  describe "#list" do
+    let(:realm_name) { "valid-realm" }
+
+    before(:each) do
+      @role_client = KeycloakAdmin.realm(realm_name).roles
+
+      stub_token_client
+      allow_any_instance_of(RestClient::Resource).to receive(:get).and_return '[{"id":"test_role_id","name":"test_role_name"}]'
+    end
+
+    it "lists roles" do
+      roles = @role_client.list
+      expect(roles.length).to eq 1
+      expect(roles[0].name).to eq "test_role_name"
+    end
+
+    it "passes rest client options" do
+      rest_client_options = {verify_ssl: OpenSSL::SSL::VERIFY_NONE}
+      allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:rest_client_options).and_return rest_client_options
+
+      expect(RestClient::Resource).to receive(:new).with(
+        "http://auth.service.io/auth/admin/realms/valid-realm/roles", rest_client_options).and_call_original
+
+      roles = @role_client.list
+      expect(roles.length).to eq 1
+      expect(roles[0].name).to eq "test_role_name"
+    end
+  end
+
+  describe "#save" do
+    let(:realm_name) { "valid-realm" }
+    let(:role) { KeycloakAdmin::RoleRepresentation.from_hash(
+      "name" => "test_role_name",
+      "composite" => false,
+      "clientRole" => false
+    )}
+
+    before(:each) do
+      @role_client = KeycloakAdmin.realm(realm_name).roles
+
+      stub_token_client
+      expect_any_instance_of(RestClient::Resource).to receive(:post).with(role.to_json, anything)
+    end
+
+    it "saves a role" do
+      @role_client.save(role)
+    end
+
+    it "passes rest client options" do
+      rest_client_options = {verify_ssl: OpenSSL::SSL::VERIFY_NONE}
+      allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:rest_client_options).and_return rest_client_options
+
+      expect(RestClient::Resource).to receive(:new).with(
+        "http://auth.service.io/auth/admin/realms/valid-realm/roles", rest_client_options).and_call_original
+
+      @role_client.save(role)
+    end
+  end
+end

data/spec/client/role_mapper_client_spec.rb

@@ -0,0 +1,47 @@
+RSpec.describe KeycloakAdmin::RoleMapperClient do
+  describe "#available_url" do
+    let(:realm_name) { "valid-realm" }
+    let(:user_id)    { "test_user" }
+
+    before(:each) do
+      @built_url = KeycloakAdmin.realm(realm_name).user(user_id).role_mapper.realm_level_url
+    end
+
+    it "return a proper url" do
+      expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/users/test_user/role-mappings/realm"
+    end
+  end
+
+  describe "#save_realm_level" do
+    let(:realm_name) { "valid-realm" }
+    let(:user_id)    { "test_user" }
+    let(:role_list) { [
+      KeycloakAdmin::RoleRepresentation.from_hash(
+        "name" => "test_role_name",
+        "composite" => false,
+        "clientRole" => false
+      )
+    ] }
+
+    before(:each) do
+      @role_mapper_client = KeycloakAdmin.realm(realm_name).user(user_id).role_mapper
+
+      stub_token_client
+      expect_any_instance_of(RestClient::Resource).to receive(:post).with(role_list.to_json, anything)
+    end
+
+    it "saves realm-elevel role mappings" do
+      @role_mapper_client.save_realm_level(role_list)
+    end
+
+    it "passes rest client options" do
+      rest_client_options = {verify_ssl: OpenSSL::SSL::VERIFY_NONE}
+      allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:rest_client_options).and_return rest_client_options
+
+      expect(RestClient::Resource).to receive(:new).with(
+        "http://auth.service.io/auth/admin/realms/valid-realm/users/test_user/role-mappings/realm", rest_client_options).and_call_original
+
+      @role_mapper_client.save_realm_level(role_list)
+    end
+  end
+end

data/spec/client/token_client_spec.rb

@@ -30,8 +30,39 @@ RSpec.describe KeycloakAdmin::TokenClient do
       @built_url = KeycloakAdmin.realm(realm_name).token.token_url
     end
 
-    it "return a proper url" do
+    it "returns a proper url" do
       expect(@built_url).to eq "http://auth.service.io/auth/realms/valid-realm/protocol/openid-connect/token"
     end
   end
+
+  describe "#get" do
+    let(:realm_name) { "valid-realm" }
+    before(:each) do
+      @token_client = KeycloakAdmin.realm(realm_name).token
+    end
+
+    it "parses the response" do
+      stub_post
+
+      token = @token_client.get
+      expect(token.access_token).to eq 'test_access_token'
+    end
+
+    it "passes rest client options" do
+      rest_client_options = {verify_ssl: OpenSSL::SSL::VERIFY_NONE}
+      allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:rest_client_options).and_return rest_client_options
+      stub_post
+
+      expect(RestClient::Resource).to receive(:new).with(
+        "http://auth.service.io/auth/realms/valid-realm/protocol/openid-connect/token", rest_client_options).and_call_original
+
+      @token_client.get
+    end
+
+    def stub_post
+      response = double
+      allow(response).to receive(:body).and_return '{"access_token":"test_access_token"}'
+      allow_any_instance_of(RestClient::Resource).to receive(:post).and_return response
+    end
+  end
 end

data/spec/client/user_client_spec.rb

@@ -96,4 +96,151 @@ RSpec.describe KeycloakAdmin::TokenClient do
       end
     end
   end
+
+  describe "#save" do
+    let(:realm_name) { "valid-realm" }
+    let(:user) { KeycloakAdmin::UserRepresentation.from_hash(
+      "username" => "test_username",
+      "createdTimestamp" => Time.now.to_i,
+    )}
+
+    before(:each) do
+      @user_client = KeycloakAdmin.realm(realm_name).users
+
+      stub_token_client
+      allow_any_instance_of(RestClient::Resource).to receive(:post)
+    end
+
+    it "saves a user" do
+      expect(@user_client.save(user)).to eq user
+    end
+
+    it "passes rest client options" do
+      rest_client_options = {verify_ssl: OpenSSL::SSL::VERIFY_NONE}
+      allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:rest_client_options).and_return rest_client_options
+
+      expect(RestClient::Resource).to receive(:new).with(
+        "http://auth.service.io/auth/admin/realms/valid-realm/users", rest_client_options).and_call_original
+
+      expect(@user_client.save(user)).to eq user
+    end
+  end
+
+  describe "#get" do
+    let(:realm_name) { "valid-realm" }
+
+    before(:each) do
+      @user_client = KeycloakAdmin.realm(realm_name).users
+
+      stub_token_client
+      allow_any_instance_of(RestClient::Resource).to receive(:get).and_return '{"username":"test_username","createdTimestamp":1559347200}'
+    end
+
+    it "parses the response" do
+      user = @user_client.get('test_user_id')
+      expect(user.username).to eq 'test_username'
+    end
+
+    it "passes rest client options" do
+      rest_client_options = {verify_ssl: OpenSSL::SSL::VERIFY_NONE}
+      allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:rest_client_options).and_return rest_client_options
+
+      expect(RestClient::Resource).to receive(:new).with(
+        "http://auth.service.io/auth/admin/realms/valid-realm/users/test_user_id", rest_client_options).and_call_original
+
+      user = @user_client.get('test_user_id')
+      expect(user.username).to eq 'test_username'
+    end
+  end
+
+  describe "#search" do
+    let(:realm_name) { "valid-realm" }
+    let(:user) { KeycloakAdmin::UserRepresentation.from_hash(
+      "username" => "test_username",
+      "createdTimestamp" => Time.now.to_i,
+    )}
+
+    before(:each) do
+      @user_client = KeycloakAdmin.realm(realm_name).users
+
+      stub_token_client
+      allow_any_instance_of(RestClient::Resource).to receive(:get).and_return '[{"username":"test_username","createdTimestamp":1559347200}]'
+    end
+
+    it "finds a user" do
+      users = @user_client.search("test_username")
+      expect(users.length).to eq 1
+      expect(users[0].username).to eq "test_username"
+    end
+
+    it "passes rest client options" do
+      rest_client_options = {verify_ssl: OpenSSL::SSL::VERIFY_NONE}
+      allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:rest_client_options).and_return rest_client_options
+
+      expect(RestClient::Resource).to receive(:new).with(
+        "http://auth.service.io/auth/admin/realms/valid-realm/users", rest_client_options).and_call_original
+
+      users = @user_client.search("test_username")
+      expect(users.length).to eq 1
+      expect(users[0].username).to eq "test_username"
+    end
+  end
+
+  describe "#list" do
+    let(:realm_name) { "valid-realm" }
+    let(:user) { KeycloakAdmin::UserRepresentation.from_hash(
+      "username" => "test_username",
+      "createdTimestamp" => Time.now.to_i,
+    )}
+
+    before(:each) do
+      @user_client = KeycloakAdmin.realm(realm_name).users
+
+      stub_token_client
+      allow_any_instance_of(RestClient::Resource).to receive(:get).and_return '[{"username":"test_username","createdTimestamp":1559347200}]'
+    end
+
+    it "lists users" do
+      users = @user_client.list
+      expect(users.length).to eq 1
+      expect(users[0].username).to eq "test_username"
+    end
+
+    it "passes rest client options" do
+      rest_client_options = {verify_ssl: OpenSSL::SSL::VERIFY_NONE}
+      allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:rest_client_options).and_return rest_client_options
+
+      expect(RestClient::Resource).to receive(:new).with(
+        "http://auth.service.io/auth/admin/realms/valid-realm/users", rest_client_options).and_call_original
+
+      users = @user_client.list
+      expect(users.length).to eq 1
+      expect(users[0].username).to eq "test_username"
+    end
+  end
+
+  describe "#delete" do
+    let(:realm_name) { "valid-realm" }
+
+    before(:each) do
+      @user_client = KeycloakAdmin.realm(realm_name).users
+
+      stub_token_client
+      allow_any_instance_of(RestClient::Resource).to receive(:delete)
+    end
+
+    it "does not fail" do
+      expect(@user_client.delete('test_user_id')).to be_truthy
+    end
+
+    it "passes rest client options" do
+      rest_client_options = {verify_ssl: OpenSSL::SSL::VERIFY_NONE}
+      allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:rest_client_options).and_return rest_client_options
+
+      expect(RestClient::Resource).to receive(:new).with(
+        "http://auth.service.io/auth/admin/realms/valid-realm/users/test_user_id", rest_client_options).and_call_original
+
+      @user_client.delete('test_user_id')
+    end
+  end
 end

data/spec/configuration_spec.rb

@@ -6,6 +6,7 @@ RSpec.describe KeycloakAdmin::RealmClient do
   let(:use_service_account) { true }
   let(:username)            { "a" }
   let(:password)            { "b" }
+  let(:rest_client_options) { {verify_ssl: OpenSSL::SSL::VERIFY_NONE} }
 
   before(:each) do
     @configuration                     = KeycloakAdmin::Configuration.new
@@ -17,6 +18,7 @@ RSpec.describe KeycloakAdmin::RealmClient do
     @configuration.use_service_account = use_service_account
     @configuration.username            = username
     @configuration.password            = password
+    @configuration.rest_client_options = rest_client_options
   end
 
   describe "#headers_for_token_retrieval" do

data/spec/representation/user_representation_spec.rb

@@ -0,0 +1,15 @@
+RSpec.describe KeycloakAdmin::UserRepresentation do
+  describe "#to_json" do
+    before(:each) do
+      @user = KeycloakAdmin::UserRepresentation.from_hash(
+        "username" => "test_username",
+        "createdTimestamp" => Time.at(1559836000).to_i,
+        "enabled" => true
+      )
+    end
+
+    it "can convert to json" do
+      expect(@user.to_json).to eq '{"id":null,"createdTimestamp":1559836000,"origin":null,"username":"test_username","email":null,"enabled":true,"emailVerified":null,"firstName":null,"lastName":null,"attributes":null,"credentials":[]}'
+    end
+  end
+end

data/spec/resource/group_resource_spec.rb

@@ -0,0 +1,14 @@
+RSpec.describe KeycloakAdmin::GroupResource do
+  describe "#resource_url" do
+    let(:realm_name) { "valid-realm" }
+    let(:group_id)   { "95985b21-d884-4bbd-b852-cb8cd365afc2" }
+
+    before(:each) do
+      @built_url = KeycloakAdmin.realm(realm_name).group(group_id).resource_url
+    end
+
+    it "return a proper url" do
+      expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/groups/95985b21-d884-4bbd-b852-cb8cd365afc2"
+    end
+  end
+end

data/spec/resource/user_resource_spec.rb

@@ -0,0 +1,14 @@
+RSpec.describe KeycloakAdmin::UserResource do
+  describe "#resource_url" do
+    let(:realm_name) { "valid-realm" }
+    let(:user_id)    { "95985b21-d884-4bbd-b852-cb8cd365afc2" }
+
+    before(:each) do
+      @built_url = KeycloakAdmin.realm(realm_name).user(user_id).resource_url
+    end
+
+    it "return a proper url" do
+      expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/users/95985b21-d884-4bbd-b852-cb8cd365afc2"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -20,3 +20,10 @@ RSpec.configure do |config|
 
   configure
 end
+
+def stub_token_client
+  allow_any_instance_of(KeycloakAdmin::TokenClient).to receive(:get).and_return KeycloakAdmin::TokenRepresentation.new(
+    'test_access_token', 'token_type', 'expires_in', 'refresh_token',
+    'refresh_expires_in', 'id_token', 'not_before_policy', 'session_state'
+  )
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak-admin
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.7.4
 platform: ruby
 authors:
 - Lorent Lempereur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-14 00:00:00.000000000 Z
+date: 2019-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-cookie
@@ -30,6 +30,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +81,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Dockerfile
 - Gemfile
 - Gemfile.lock
@@ -75,25 +90,46 @@ files:
 - keycloak-admin.gemspec
 - lib/keycloak-admin.rb
 - lib/keycloak-admin/client/client.rb
+- lib/keycloak-admin/client/client_client.rb
+- lib/keycloak-admin/client/client_role_mappings_client.rb
 - lib/keycloak-admin/client/configurable_token_client.rb
+- lib/keycloak-admin/client/group_client.rb
 - lib/keycloak-admin/client/realm_client.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/representation/camel_json.rb
+- lib/keycloak-admin/representation/client_representation.rb
 - lib/keycloak-admin/representation/credential_representation.rb
+- lib/keycloak-admin/representation/group_representation.rb
 - lib/keycloak-admin/representation/impersonation_redirection_representation.rb
 - lib/keycloak-admin/representation/impersonation_representation.rb
+- lib/keycloak-admin/representation/realm_representation.rb
 - lib/keycloak-admin/representation/representation.rb
+- lib/keycloak-admin/representation/role_representation.rb
 - lib/keycloak-admin/representation/token_representation.rb
 - lib/keycloak-admin/representation/user_representation.rb
+- lib/keycloak-admin/resource/base_role_containing_resource.rb
+- lib/keycloak-admin/resource/group_resource.rb
+- lib/keycloak-admin/resource/user_resource.rb
 - lib/keycloak-admin/version.rb
+- spec/client/client_client_spec.rb
+- spec/client/client_role_mappings_client_spec.rb
+- spec/client/client_spec.rb
 - spec/client/configurable_token_client_spec.rb
+- spec/client/group_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/representation/impersonation_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:
@@ -107,15 +143,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Keycloak Admin REST API client written in Ruby