keycloak-admin 0.6.5 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1514ae886ef6e9a3b7a0716ea6be8f472222fdd9
-  data.tar.gz: 1ba37cacfd7668d8c3d5b8f934f31de62c21b10d
+  metadata.gz: 970da832a135573c026406dd6e24bebad0faadde
+  data.tar.gz: 0116019f2c32443bbd8c9567b8243cb84e75da7a
 SHA512:
-  metadata.gz: 9bf9575e8155e8803d6675aa764ddd01bbc761c9a672f8ea0cab5974503b5d24cf1ea955fa25aa5b1a1619fd8063002f5d6802b9541bd93747378c46609f332a
-  data.tar.gz: f4ce9faf771762e2b319bb02bfbef51015f1971617f08c2673d2d235abace7427d8eebb1f8267f54a09b1475a60e9bdb9f0df4441b3bb5a923ba3f46b9e7760f
+  metadata.gz: 65fab8de261bdb5bbef86e05961e4c49858143d6b0eb3e1282ed13b67aa3d4b2e2a7bf6a54788cf02ebaee78eea9c2658644d54e70b45777e6348ac4867c199e
+  data.tar.gz: b8ab004c2772051d424f277572b42c57ef523d04fc1f43274c97964bd4dc1291b54d24bb70b8785b0fe404c30a23f2bba2636efb244ac6a4eb663bc40e58708f

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    keycloak-admin (0.6.5)
+    keycloak-admin (0.7.0)
       http-cookie (~> 1.0, >= 1.0.3)
+      rest-client (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -13,6 +14,14 @@ GEM
       unf (>= 0.0.5, < 1.0.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
+    netrc (0.11.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -28,7 +37,7 @@ GEM
     rspec-support (3.7.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.5)
+    unf_ext (0.0.7.6)
 
 PLATFORMS
   ruby
@@ -39,4 +48,4 @@ DEPENDENCIES
   rspec (= 3.7.0)
 
 BUNDLED WITH
-   1.16.3
+   1.17.3

data/README.md

@@ -4,7 +4,7 @@
 Ruby client that acts as a client for the Keycloak REST API.
 This gem basically acts as an url builder using `http-client` to get responses and serialize them into _representation_ objects.
 
-_Warning: This beta gem is currently used for personal used. Most Keycloak Admin features are not implemented yet._
+_Warning: This beta gem is currently used for personal use. Most Keycloak Admin features are not implemented yet._
 
 ## Install
 
@@ -12,7 +12,7 @@ This gem *does not* require Rails.
 For example, using `bundle`, add this line to your Gemfile.
 
 ```ruby
-gem "keycloak-admin", "0.6.5"
+gem "keycloak-admin", "0.7.0"
 ```
 
 ## Login
@@ -69,12 +69,12 @@ All options have a default value. However, all of them can be changed in your in
 | Option | Default Value | Type | Required? | Description  | Example |
 | ---- | ----- | ------ | ----- | ------ | ----- |
 | `server_url` | `nil`| String | Required | The base url where your Keycloak server is located. This value can be retrieved in your Keycloak client configuration. | `server_domain` | `nil`| String | Required | Public domain that identify your authentication cookies. | `auth.service.io` |
-| `client_realm_name` | `""`| String | Required | Name of the realm that contain the admin client. | `master` |
+| `client_realm_name` | `""`| String | Required | Name of the realm that contains the admin client. | `master` |
 | `client_id` | `admin-cli`| String | Required | Client that should be used to access admin capabilities. | `api-cli` |
 | `client_secret` | `nil`| String | Optional | If your client is `confidential`, this parameter must be specified. | `4e3c481c-f823-4a6a-b8a7-bf8c86e3eac3` |
-| `use_service_account` | `true` | Boolean | Required | `true` if the connection to the client uses a Service Account. `false` if the connetio nto the client uses a username/password credential | `false` | 
-| `username` | `nil`| String | Optional | Username that access to the Admin REST API. Recommended if `user_service_account` is set to `false`. | `mummy` |
-| `password` | `nil`| String | Optional | Clear password that access to the Admin REST API. Recommended if `user_service_account` is set to `false`. | `bobby` |
+| `use_service_account` | `true` | Boolean | Required | `true` if the connection to the client uses a Service Account. `false` if the connection to the client uses a username/password credential. | `false` | 
+| `username` | `nil`| String | Optional | Username to access the Admin REST API. Recommended if `user_service_account` is set to `false`. | `mummy` |
+| `password` | `nil`| String | Optional | Clear password to access the Admin REST API. Recommended if `user_service_account` is set to `false`. | `bobby` |
 | `logger` | `Logger.new(STDOUT)`| Logger | Optional | The logger used by `keycloak-admin` | `Rails.logger` | 
 
 
@@ -97,7 +97,7 @@ Returns an instance of `KeycloakAdmin::TokenRepresentation`.
 KeycloakAdmin.realm("a_realm").token.get
 ```
 
-### Get a user from its idenfier
+### Get a user from its identifier
 
 Returns an instance of `KeycloakAdmin::UserRepresentation` or `nil` when this user does not exist.
 
@@ -132,6 +132,12 @@ KeycloakAdmin.realm("a_realm").users.update("05c135c6-5ad8-4e17-b1fa-635fc089fd7
 })
 ```
 
+### Delete a user
+
+```ruby
+KeycloakAdmin.realm("a_realm").users.delete(user_id)
+```
+
 ### Create and save a user with password and a locale
 
 Returns the created user of type `KeycloakAdmin::UserRepresentation`.

data/keycloak-admin.gemspec

@@ -15,7 +15,10 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files -z`.split("\x0")
   spec.require_paths = ["lib"]
   
+  spec.required_ruby_version = '>= 2.3'
+
   spec.add_dependency "http-cookie", "~> 1.0", ">= 1.0.3"
+  spec.add_dependency "rest-client", "~> 2.0"
   spec.add_development_dependency "rspec",  "3.7.0"
   spec.add_development_dependency "byebug", "9.1.0"
 end

data/lib/keycloak-admin.rb

@@ -42,6 +42,7 @@ module KeycloakAdmin
       config.use_service_account = true
       config.username            = nil
       config.password            = nil
+      config.rest_client_options = nil
     end
   end
 

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

@@ -23,6 +23,8 @@ module KeycloakAdmin
 
     def execute_http
       yield
+    rescue RestClient::Exceptions::Timeout => e
+      raise
     rescue RestClient::ExceptionWithResponse => e
       http_error(e.response)
     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

@@ -24,11 +24,9 @@ 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)
@@ -40,7 +38,7 @@ module KeycloakAdmin
 
     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

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/representation.rb

@@ -1,3 +1,4 @@
+require "json"
 require_relative "camel_json"
 
 class Representation

data/lib/keycloak-admin/version.rb

@@ -1,3 +1,3 @@
 module KeycloakAdmin
-  VERSION = "0.6.5"
+  VERSION = "0.7.0"
 end

data/spec/client/client_spec.rb

@@ -0,0 +1,28 @@
+RSpec.describe KeycloakAdmin::Client do
+  describe "#execute_http" do
+    let(:realm_name) { "valid-realm" }
+    before(:each) do
+      @client = KeycloakAdmin::Client.new(KeycloakAdmin.config)
+    end
+
+    it "handles timeout" do
+      expect do
+        @client.execute_http do
+          raise RestClient::Exceptions::OpenTimeout.new
+        end
+      end.to raise_error(RestClient::Exceptions::OpenTimeout)
+    end
+
+    it "handles response exception" do
+      response = double
+      allow(response).to receive(:code).and_return 500
+      allow(response).to receive(:body).and_return "Server error"
+
+      expect do
+        @client.execute_http do
+          raise RestClient::ExceptionWithResponse.new(response)
+        end
+      end.to raise_error("Keycloak: The request failed with response code 500 and message: Server error")
+    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,60 @@ RSpec.describe KeycloakAdmin::TokenClient do
       end
     end
   end
+
+  describe "#get" do
+    let(:realm_name) { "valid-realm" }
+    before(:each) do
+      @user_client = KeycloakAdmin.realm("a_realm").users
+
+      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'
+      )
+      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/a_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 "#delete" do
+    let(:realm_name) { "valid-realm" }
+    before(:each) do
+      @user_client = KeycloakAdmin.realm("a_realm").users
+
+      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'
+      )
+      allow_any_instance_of(RestClient::Resource).to receive(:delete)
+    end
+
+    it "parses the response" do
+      @user_client.delete('test_user_id')
+    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/a_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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak-admin
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.7.0
 platform: ruby
 authors:
 - Lorent Lempereur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-14 00:00:00.000000000 Z
+date: 2019-06-06 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
@@ -88,6 +102,7 @@ files:
 - lib/keycloak-admin/representation/token_representation.rb
 - lib/keycloak-admin/representation/user_representation.rb
 - lib/keycloak-admin/version.rb
+- spec/client/client_spec.rb
 - spec/client/configurable_token_client_spec.rb
 - spec/client/realm_client_spec.rb
 - spec/client/token_client_spec.rb
@@ -107,7 +122,7 @@ 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:
   - - ">="